openapi: 3.2.0 info: title: Elasticsearch Request & Response Specification Indices API license: name: Apache 2.0 url: https://github.com/elastic/elasticsearch-specification/blob/main/LICENSE version: '' tags: - name: indices paths: /_component_template/{name}: get: tags: - indices summary: Get component templates description: 'Get information about component templates. ## Required authorization * Cluster privileges: `manage_index_templates` ' operationId: cluster-get-component-template-1 parameters: - $ref: '#/components/parameters/cluster.get_component_template-name' - $ref: '#/components/parameters/cluster.get_component_template-flat_settings' - $ref: '#/components/parameters/cluster.get_component_template-settings_filter' - $ref: '#/components/parameters/cluster.get_component_template-include_defaults' - $ref: '#/components/parameters/cluster.get_component_template-local' - $ref: '#/components/parameters/cluster.get_component_template-master_timeout' responses: '200': $ref: '#/components/responses/cluster.get_component_template-200' x-state: Generally available; Added in 7.8.0 x-metaTags: - content: Elasticsearch name: product_name put: tags: - indices summary: Create or update a component template description: 'Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. An index template can be composed of multiple component templates. To use a component template, specify it in an index template’s `composed_of` list. Component templates are only applied to new data streams and indices as part of a matching index template. Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. Component templates are only used during index creation. For data streams, this includes data stream creation and the creation of a stream’s backing indices. Changes to component templates do not affect existing indices, including a stream’s backing indices. You can use C-style `/* *\/` block comments in component templates. You can include comments anywhere in the request body except before the opening curly bracket. **Applying component templates** You cannot directly apply a component template to a data stream or index. To be applied, a component template must be included in an index template''s `composed_of` list. ## Required authorization * Cluster privileges: `manage_index_templates` ' operationId: cluster-put-component-template parameters: - $ref: '#/components/parameters/cluster.put_component_template-name' - $ref: '#/components/parameters/cluster.put_component_template-create' - $ref: '#/components/parameters/cluster.put_component_template-cause' - $ref: '#/components/parameters/cluster.put_component_template-master_timeout' requestBody: $ref: '#/components/requestBodies/cluster.put_component_template' responses: '200': $ref: '#/components/responses/cluster.put_component_template-200' x-state: Generally available; Added in 7.8.0 x-metaTags: - content: Elasticsearch name: product_name post: tags: - indices summary: Create or update a component template description: 'Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. An index template can be composed of multiple component templates. To use a component template, specify it in an index template’s `composed_of` list. Component templates are only applied to new data streams and indices as part of a matching index template. Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. Component templates are only used during index creation. For data streams, this includes data stream creation and the creation of a stream’s backing indices. Changes to component templates do not affect existing indices, including a stream’s backing indices. You can use C-style `/* *\/` block comments in component templates. You can include comments anywhere in the request body except before the opening curly bracket. **Applying component templates** You cannot directly apply a component template to a data stream or index. To be applied, a component template must be included in an index template''s `composed_of` list. ## Required authorization * Cluster privileges: `manage_index_templates` ' operationId: cluster-put-component-template-1 parameters: - $ref: '#/components/parameters/cluster.put_component_template-name' - $ref: '#/components/parameters/cluster.put_component_template-create' - $ref: '#/components/parameters/cluster.put_component_template-cause' - $ref: '#/components/parameters/cluster.put_component_template-master_timeout' requestBody: $ref: '#/components/requestBodies/cluster.put_component_template' responses: '200': $ref: '#/components/responses/cluster.put_component_template-200' x-state: Generally available; Added in 7.8.0 x-metaTags: - content: Elasticsearch name: product_name delete: tags: - indices summary: Delete component templates description: 'Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. ## Required authorization * Cluster privileges: `manage_index_templates` ' operationId: cluster-delete-component-template parameters: - in: path name: name description: Comma-separated list or wildcard expression of component template names used to limit the request. required: true deprecated: false schema: $ref: '#/components/schemas/_types.Names' style: simple - in: query name: master_timeout 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.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form - in: query name: timeout description: 'Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/_types.AcknowledgedResponseBase' x-state: Generally available; Added in 7.8.0 x-metaTags: - content: Elasticsearch name: product_name head: tags: - indices summary: Check component templates description: Returns information about whether a particular component template exists. operationId: cluster-exists-component-template parameters: - in: path name: name description: 'Comma-separated list of component template names used to limit the request. Wildcard (*) expressions are supported.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Names' style: simple - in: query name: master_timeout 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.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form - in: query name: local description: 'If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.' deprecated: true schema: default: false type: boolean style: form responses: '200': description: '' content: application/json: {} x-state: Generally available; Added in 7.8.0 x-metaTags: - content: Elasticsearch name: product_name /_component_template: get: tags: - indices summary: Get component templates description: 'Get information about component templates. ## Required authorization * Cluster privileges: `manage_index_templates` ' operationId: cluster-get-component-template parameters: - $ref: '#/components/parameters/cluster.get_component_template-flat_settings' - $ref: '#/components/parameters/cluster.get_component_template-settings_filter' - $ref: '#/components/parameters/cluster.get_component_template-include_defaults' - $ref: '#/components/parameters/cluster.get_component_template-local' - $ref: '#/components/parameters/cluster.get_component_template-master_timeout' responses: '200': $ref: '#/components/responses/cluster.get_component_template-200' x-state: Generally available; Added in 7.8.0 x-metaTags: - content: Elasticsearch name: product_name /_dangling/{index_uuid}: post: tags: - indices summary: Import a dangling index description: 'If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. ## Required authorization * Cluster privileges: `manage` ' operationId: dangling-indices-import-dangling-index parameters: - in: path name: index_uuid description: The UUID of the index to import. Use the get dangling indices API to locate the UUID. required: true deprecated: false schema: $ref: '#/components/schemas/_types.Uuid' style: simple - in: query name: accept_data_loss description: 'This parameter must be set to true to import a dangling index. Because Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster.' deprecated: false schema: default: false type: boolean style: form - in: query name: master_timeout description: The period to wait for a connection to the master node. deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form - in: query name: timeout description: The period to wait for a response. deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/_types.AcknowledgedResponseBase' examples: ImportDanglingIndexResponseExample1: description: 'A successful response from `POST /_dangling/zmM4e0JtBkeUjiHD-MihPQ?accept_data_loss=true`. ' value: "{\n \"acknowledged\": true\n}" x-state: Generally available; Added in 7.9.0 x-metaTags: - content: Elasticsearch name: product_name delete: tags: - indices summary: Delete a dangling index description: 'If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. ## Required authorization * Cluster privileges: `manage` ' operationId: dangling-indices-delete-dangling-index parameters: - in: path name: index_uuid description: The UUID of the index to delete. Use the get dangling indices API to find the UUID. required: true deprecated: false schema: $ref: '#/components/schemas/_types.Uuid' style: simple - in: query name: accept_data_loss description: This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index. deprecated: false schema: default: false type: boolean style: form - in: query name: master_timeout description: The period to wait for a connection to the master node. deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form - in: query name: timeout description: The period to wait for a response. deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/_types.AcknowledgedResponseBase' x-state: Generally available; Added in 7.9.0 x-metaTags: - content: Elasticsearch name: product_name /_dangling: get: tags: - indices summary: Get the dangling indices description: 'If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. Use this API to list dangling indices, which you can then import or delete. ## Required authorization * Cluster privileges: `manage` ' operationId: dangling-indices-list-dangling-indices responses: '200': description: '' content: application/json: schema: type: object properties: dangling_indices: type: array items: $ref: '#/components/schemas/dangling_indices.list_dangling_indices.DanglingIndex' required: - dangling_indices examples: ListDanglingIndicesResponseExample1: value: "{\n \"dangling_indices\": [\n {\n \"index_name\": \"my-index-000001\",\n \"index_uuid\": \"zmM4e0JtBkeUjiHD-MihPQ\",\n \"creation_date_millis\": 1589414451372,\n \"node_ids\": [\n \"pL47UN3dAb2d5RCWP6lQ3e\"\n ]\n }\n ]\n}" x-state: Generally available; Added in 7.9.0 x-metaTags: - content: Elasticsearch name: product_name /{index}/_block/{block}: put: tags: - indices summary: Add an index block description: 'Add an index block to an index. Index blocks limit the operations allowed on an index by blocking specific operation types.' operationId: indices-add-block parameters: - in: path name: index description: 'A comma-separated list or wildcard expression of index names used to limit the request. By default, you must explicitly name the indices you are adding blocks to. To allow the adding of blocks to indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`. You can update this setting in the `elasticsearch.yml` file or by using the cluster update settings API.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple - in: path name: block description: The block type to add to the index. required: true deprecated: false schema: $ref: '#/components/schemas/indices._types.IndicesBlockOptions' style: simple - in: query name: allow_no_indices description: 'A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.' deprecated: false schema: default: true type: boolean style: form - in: query name: expand_wildcards description: 'The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`.' deprecated: false schema: default: open allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form - in: query name: ignore_unavailable description: 'If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.' deprecated: false schema: default: false type: boolean style: form - in: query name: master_timeout description: 'The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form - in: query name: timeout description: 'The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. It can also be set to `-1` to indicate that the request should never timeout.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: type: object properties: acknowledged: type: boolean shards_acknowledged: type: boolean indices: type: array items: $ref: '#/components/schemas/indices.add_block.AddIndicesBlockStatus' required: - acknowledged - shards_acknowledged - indices examples: IndicesAddBlockResponseExample1: description: A successful response from `PUT /my-index-000001/_block/write`, which adds an index block to an index.' value: "{\n \"acknowledged\" : true,\n \"shards_acknowledged\" : true,\n \"indices\" : [ {\n \"name\" : \"my-index-000001\",\n \"blocked\" : true\n } ]\n}" x-state: Generally available; Added in 7.9.0 x-metaTags: - content: Elasticsearch name: product_name delete: tags: - indices summary: Remove an index block description: 'Remove an index block from an index. Index blocks limit the operations allowed on an index by blocking specific operation types. ## Required authorization * Index privileges: `manage` ' operationId: indices-remove-block parameters: - in: path name: index description: 'A comma-separated list or wildcard expression of index names used to limit the request. By default, you must explicitly name the indices you are removing blocks from. To allow the removal of blocks from indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`. You can update this setting in the `elasticsearch.yml` file or by using the cluster update settings API.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple - in: path name: block description: The block type to remove from the index. required: true deprecated: false schema: $ref: '#/components/schemas/indices._types.IndicesBlockOptions' style: simple - in: query name: allow_no_indices description: 'A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.' deprecated: false schema: default: true type: boolean style: form - in: query name: expand_wildcards description: 'The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`.' deprecated: false schema: default: open allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form - in: query name: ignore_unavailable description: 'If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.' deprecated: false schema: default: false type: boolean style: form - in: query name: master_timeout description: 'The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form - in: query name: timeout description: 'The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. It can also be set to `-1` to indicate that the request should never timeout.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: type: object properties: acknowledged: type: boolean indices: type: array items: $ref: '#/components/schemas/indices.remove_block.RemoveIndicesBlockStatus' required: - acknowledged - indices examples: IndicesRemoveBlockResponseExample1: description: A successful response from `DELETE /my-index-000001/_block/write`, which removes an index block from an index.' value: "{\n \"acknowledged\" : true,\n \"indices\" : [ {\n \"name\" : \"my-index-000001\",\n \"unblocked\" : true\n } ]\n}" x-state: Generally available; Added in 9.1.0 x-metaTags: - content: Elasticsearch name: product_name /_analyze: get: tags: - indices summary: Get tokens from text analysis description: 'The analyze API performs analysis on a text string and returns the resulting tokens. Generating excessive amount of tokens may cause a node to run out of memory. The `index.analyze.max_token_count` setting enables you to limit the number of tokens that can be produced. If more than this limit of tokens gets generated, an error occurs. The `_analyze` endpoint without a specified index will always use `10000` as its limit. ## Required authorization * Index privileges: `index` ' externalDocs: description: Learn more about text analysis url: https://www.elastic.co/docs/manage-data/data-store/text-analysis x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-analyze.html operationId: indices-analyze parameters: - $ref: '#/components/parameters/indices.analyze-index_' requestBody: $ref: '#/components/requestBodies/indices.analyze' responses: '200': $ref: '#/components/responses/indices.analyze-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name post: tags: - indices summary: Get tokens from text analysis description: 'The analyze API performs analysis on a text string and returns the resulting tokens. Generating excessive amount of tokens may cause a node to run out of memory. The `index.analyze.max_token_count` setting enables you to limit the number of tokens that can be produced. If more than this limit of tokens gets generated, an error occurs. The `_analyze` endpoint without a specified index will always use `10000` as its limit. ## Required authorization * Index privileges: `index` ' externalDocs: description: Learn more about text analysis url: https://www.elastic.co/docs/manage-data/data-store/text-analysis x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-analyze.html operationId: indices-analyze-1 parameters: - $ref: '#/components/parameters/indices.analyze-index_' requestBody: $ref: '#/components/requestBodies/indices.analyze' responses: '200': $ref: '#/components/responses/indices.analyze-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /{index}/_analyze: get: tags: - indices summary: Get tokens from text analysis description: 'The analyze API performs analysis on a text string and returns the resulting tokens. Generating excessive amount of tokens may cause a node to run out of memory. The `index.analyze.max_token_count` setting enables you to limit the number of tokens that can be produced. If more than this limit of tokens gets generated, an error occurs. The `_analyze` endpoint without a specified index will always use `10000` as its limit. ## Required authorization * Index privileges: `index` ' externalDocs: description: Learn more about text analysis url: https://www.elastic.co/docs/manage-data/data-store/text-analysis x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-analyze.html operationId: indices-analyze-2 parameters: - $ref: '#/components/parameters/indices.analyze-index' - $ref: '#/components/parameters/indices.analyze-index_' requestBody: $ref: '#/components/requestBodies/indices.analyze' responses: '200': $ref: '#/components/responses/indices.analyze-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name post: tags: - indices summary: Get tokens from text analysis description: 'The analyze API performs analysis on a text string and returns the resulting tokens. Generating excessive amount of tokens may cause a node to run out of memory. The `index.analyze.max_token_count` setting enables you to limit the number of tokens that can be produced. If more than this limit of tokens gets generated, an error occurs. The `_analyze` endpoint without a specified index will always use `10000` as its limit. ## Required authorization * Index privileges: `index` ' externalDocs: description: Learn more about text analysis url: https://www.elastic.co/docs/manage-data/data-store/text-analysis x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-analyze.html operationId: indices-analyze-3 parameters: - $ref: '#/components/parameters/indices.analyze-index' - $ref: '#/components/parameters/indices.analyze-index_' requestBody: $ref: '#/components/requestBodies/indices.analyze' responses: '200': $ref: '#/components/responses/indices.analyze-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /_cache/clear: post: tags: - indices summary: Clear the cache description: 'Clear the cache of one or more indices. For data streams, the API clears the caches of the stream''s backing indices. By default, the clear cache API clears all caches. To clear only specific caches, use the `fielddata`, `query`, or `request` parameters. To clear the cache only of specific fields, use the `fields` parameter. ## Required authorization * Index privileges: `manage` ' operationId: indices-clear-cache parameters: - $ref: '#/components/parameters/indices.clear_cache-index_' - $ref: '#/components/parameters/indices.clear_cache-allow_no_indices' - $ref: '#/components/parameters/indices.clear_cache-expand_wildcards' - $ref: '#/components/parameters/indices.clear_cache-fielddata' - $ref: '#/components/parameters/indices.clear_cache-fields' - $ref: '#/components/parameters/indices.clear_cache-ignore_unavailable' - $ref: '#/components/parameters/indices.clear_cache-query' - $ref: '#/components/parameters/indices.clear_cache-request' responses: '200': $ref: '#/components/responses/indices.clear_cache-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /{index}/_cache/clear: post: tags: - indices summary: Clear the cache description: 'Clear the cache of one or more indices. For data streams, the API clears the caches of the stream''s backing indices. By default, the clear cache API clears all caches. To clear only specific caches, use the `fielddata`, `query`, or `request` parameters. To clear the cache only of specific fields, use the `fields` parameter. ## Required authorization * Index privileges: `manage` ' operationId: indices-clear-cache-1 parameters: - $ref: '#/components/parameters/indices.clear_cache-index' - $ref: '#/components/parameters/indices.clear_cache-index_' - $ref: '#/components/parameters/indices.clear_cache-allow_no_indices' - $ref: '#/components/parameters/indices.clear_cache-expand_wildcards' - $ref: '#/components/parameters/indices.clear_cache-fielddata' - $ref: '#/components/parameters/indices.clear_cache-fields' - $ref: '#/components/parameters/indices.clear_cache-ignore_unavailable' - $ref: '#/components/parameters/indices.clear_cache-query' - $ref: '#/components/parameters/indices.clear_cache-request' responses: '200': $ref: '#/components/responses/indices.clear_cache-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /{index}/_clone/{target}: put: tags: - indices summary: Clone an index description: 'Clone an existing index into a new index. Each original primary shard is cloned into a new primary shard in the new index. IMPORTANT: Elasticsearch does not apply index templates to the resulting index. The API also does not copy index metadata from the original index. Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. For example, if you clone a CCR follower index, the resulting clone will not be a follower index. The clone API copies most index settings from the source index to the resulting index, with the exception of `index.number_of_replicas` and `index.auto_expand_replicas`. To set the number of replicas in the resulting index, configure these settings in the clone request. Cloning works as follows: * First, it creates a new target index with the same definition as the source index. * Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process. * Finally, it recovers the target index as though it were a closed index which had just been re-opened. IMPORTANT: Indices can only be cloned if they meet the following requirements: * The index must be marked as read-only and have a cluster health status of green. * The target index must not exist. * The source index must have the same number of primary shards as the target index. * The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index. The current write index on a data stream cannot be cloned. In order to clone the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be cloned. NOTE: Mappings cannot be specified in the `_clone` request. The mappings of the source index will be used for the target index. **Monitor the cloning process** The cloning process can be monitored with the cat recovery API or the cluster health API can be used to wait until all primary shards have been allocated by setting the `wait_for_status` parameter to `yellow`. The `_clone` API returns as soon as the target index has been added to the cluster state, before any shards have been allocated. At this point, all shards are in the state unassigned. If, for any reason, the target index can''t be allocated, its primary shard will remain unassigned until it can be allocated on that node. Once the primary shard is allocated, it moves to state initializing, and the clone process begins. When the clone operation completes, the shard will become active. At that point, Elasticsearch will try to allocate any replicas and may decide to relocate the primary shard to another node. **Wait for active shards** Because the clone operation creates a new index to clone the shards to, the wait for active shards setting on index creation applies to the clone index action as well. ## Required authorization * Index privileges: `manage` ' operationId: indices-clone parameters: - $ref: '#/components/parameters/indices.clone-index' - $ref: '#/components/parameters/indices.clone-target' - $ref: '#/components/parameters/indices.clone-master_timeout' - $ref: '#/components/parameters/indices.clone-timeout' - $ref: '#/components/parameters/indices.clone-wait_for_active_shards' requestBody: $ref: '#/components/requestBodies/indices.clone' responses: '200': $ref: '#/components/responses/indices.clone-200' x-state: Generally available; Added in 7.4.0 x-metaTags: - content: Elasticsearch name: product_name post: tags: - indices summary: Clone an index description: 'Clone an existing index into a new index. Each original primary shard is cloned into a new primary shard in the new index. IMPORTANT: Elasticsearch does not apply index templates to the resulting index. The API also does not copy index metadata from the original index. Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. For example, if you clone a CCR follower index, the resulting clone will not be a follower index. The clone API copies most index settings from the source index to the resulting index, with the exception of `index.number_of_replicas` and `index.auto_expand_replicas`. To set the number of replicas in the resulting index, configure these settings in the clone request. Cloning works as follows: * First, it creates a new target index with the same definition as the source index. * Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process. * Finally, it recovers the target index as though it were a closed index which had just been re-opened. IMPORTANT: Indices can only be cloned if they meet the following requirements: * The index must be marked as read-only and have a cluster health status of green. * The target index must not exist. * The source index must have the same number of primary shards as the target index. * The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index. The current write index on a data stream cannot be cloned. In order to clone the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be cloned. NOTE: Mappings cannot be specified in the `_clone` request. The mappings of the source index will be used for the target index. **Monitor the cloning process** The cloning process can be monitored with the cat recovery API or the cluster health API can be used to wait until all primary shards have been allocated by setting the `wait_for_status` parameter to `yellow`. The `_clone` API returns as soon as the target index has been added to the cluster state, before any shards have been allocated. At this point, all shards are in the state unassigned. If, for any reason, the target index can''t be allocated, its primary shard will remain unassigned until it can be allocated on that node. Once the primary shard is allocated, it moves to state initializing, and the clone process begins. When the clone operation completes, the shard will become active. At that point, Elasticsearch will try to allocate any replicas and may decide to relocate the primary shard to another node. **Wait for active shards** Because the clone operation creates a new index to clone the shards to, the wait for active shards setting on index creation applies to the clone index action as well. ## Required authorization * Index privileges: `manage` ' operationId: indices-clone-1 parameters: - $ref: '#/components/parameters/indices.clone-index' - $ref: '#/components/parameters/indices.clone-target' - $ref: '#/components/parameters/indices.clone-master_timeout' - $ref: '#/components/parameters/indices.clone-timeout' - $ref: '#/components/parameters/indices.clone-wait_for_active_shards' requestBody: $ref: '#/components/requestBodies/indices.clone' responses: '200': $ref: '#/components/responses/indices.clone-200' x-state: Generally available; Added in 7.4.0 x-metaTags: - content: Elasticsearch name: product_name /{index}/_close: post: tags: - indices summary: Close an index description: 'A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. It is not possible to index documents or to search for documents in a closed index. Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. The shards will then go through the normal recovery process. The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. You can open and close multiple indices. An error is thrown if the request explicitly refers to a missing index. This behaviour can be turned off using the `ignore_unavailable=true` parameter. By default, you must explicitly name the indices you are opening or closing. To open or close indices with `_all`, `*`, or other wildcard expressions, change the` action.destructive_requires_name` setting to `false`. This setting can also be changed with the cluster update settings API. Closed indices consume a significant amount of disk-space which can cause problems in managed environments. Closing indices can be turned off with the cluster settings API by setting `cluster.indices.close.enable` to `false`. ## Required authorization * Index privileges: `manage` ' operationId: indices-close parameters: - in: path name: index description: Comma-separated list or wildcard expression of index names used to limit the request. required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple - in: query name: allow_no_indices description: 'A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.' deprecated: false schema: default: true type: boolean style: form - in: query name: expand_wildcards description: 'Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.' deprecated: false schema: default: open allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form - in: query name: ignore_unavailable description: 'If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.' deprecated: false schema: default: false type: boolean style: form - in: query name: master_timeout 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.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form - in: query name: timeout description: 'Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form - in: query name: wait_for_active_shards description: 'The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).' deprecated: false schema: default: '1' allOf: - $ref: '#/components/schemas/_types.WaitForActiveShards' style: form responses: '200': description: '' content: application/json: schema: type: object properties: acknowledged: type: boolean indices: type: object additionalProperties: $ref: '#/components/schemas/indices.close.CloseIndexResult' shards_acknowledged: type: boolean required: - acknowledged - indices - shards_acknowledged examples: CloseIndexResponseExample1: description: A successful response for closing an index. value: "{\n \"acknowledged\": true,\n \"shards_acknowledged\": true,\n \"indices\": {\n \"my-index-000001\": {\n \"closed\": true\n }\n }\n}" x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /{index}: get: tags: - indices summary: Get index information description: 'Get information about one or more indices. For data streams, the API returns information about the stream’s backing indices. ## Required authorization * Index privileges: `view_index_metadata`,`manage` ' operationId: indices-get parameters: - in: path name: index description: 'Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple - in: query name: allow_no_indices description: 'A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.' deprecated: false schema: default: true type: boolean style: form - in: query name: expand_wildcards description: 'Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.' deprecated: false schema: default: open allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form - in: query name: flat_settings description: If true, returns settings in flat format. deprecated: false schema: default: false type: boolean style: form - in: query name: ignore_unavailable description: 'If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.' deprecated: false schema: default: false type: boolean style: form - in: query name: include_defaults description: If true, return all default settings in the response. deprecated: false schema: default: false type: boolean style: form - in: query name: local description: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. deprecated: false schema: default: false type: boolean style: form - in: query name: master_timeout 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. deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form - in: query name: features description: Return only information on specified index features deprecated: false schema: default: '[''aliases'', ''mappings'', ''settings'']' allOf: - $ref: '#/components/schemas/indices.get.Features' x-state: Generally available; Added in 8.1.0 style: form responses: '200': description: '' content: application/json: schema: type: object additionalProperties: $ref: '#/components/schemas/indices._types.IndexState' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name put: tags: - indices summary: Create an index description: 'You can use the create index API to add a new index to an Elasticsearch cluster. When creating an index, you can specify the following: * Settings for the index. * Mappings for fields in the index. * Index aliases **Wait for active shards** By default, index creation will only return a response to the client when the primary copies of each shard have been started, or the request times out. The index creation response will indicate what happened. For example, `acknowledged` indicates whether the index was successfully created in the cluster, `while shards_acknowledged` indicates whether the requisite number of shard copies were started for each shard in the index before timing out. Note that it is still possible for either `acknowledged` or `shards_acknowledged` to be `false`, but for the index creation to be successful. These values simply indicate whether the operation completed before the timeout. If `acknowledged` is false, the request timed out before the cluster state was updated with the newly created index, but it probably will be created sometime soon. If `shards_acknowledged` is false, then the request timed out before the requisite number of shards were started (by default just the primaries), even if the cluster state was successfully updated to reflect the newly created index (that is to say, `acknowledged` is `true`). You can change the default of only waiting for the primary shards to start through the index setting `index.write.wait_for_active_shards`. Note that changing this setting will also affect the `wait_for_active_shards` value on all subsequent write operations. ## Required authorization * Index privileges: `create_index`,`manage` ' operationId: indices-create parameters: - in: path name: index description: 'Name of the index you wish to create. Index names must meet the following criteria: * Lowercase only * Cannot include `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, ` ` (space character), `,`, or `#` * Indices prior to 7.0 could contain a colon (`:`), but that has been deprecated and will not be supported in later versions * Cannot start with `-`, `_`, or `+` * Cannot be `.` or `..` * Cannot be longer than 255 bytes (note thtat it is bytes, so multi-byte characters will reach the limit faster) * Names starting with `.` are deprecated, except for hidden indices and internal indices managed by plugins' required: true deprecated: false schema: $ref: '#/components/schemas/_types.IndexName' style: simple - in: query name: master_timeout 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.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form - in: query name: timeout description: 'Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form - in: query name: wait_for_active_shards description: 'The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).' deprecated: false schema: default: '1' allOf: - $ref: '#/components/schemas/_types.WaitForActiveShards' style: form requestBody: content: application/json: schema: type: object properties: aliases: description: Aliases for the index. type: object additionalProperties: $ref: '#/components/schemas/indices._types.Alias' mappings: description: 'Mapping for fields in the index. If specified, this mapping can include: - Field names - Field data types - Mapping parameters' allOf: - $ref: '#/components/schemas/_types.mapping.TypeMapping' settings: description: Configuration options for the index. allOf: - $ref: '#/components/schemas/indices._types.IndexSettings' examples: indicesCreateRequestExample1: summary: Create an index. description: This request specifies the `number_of_shards` and `number_of_replicas`. value: "{\n \"settings\": {\n \"number_of_shards\": 3,\n \"number_of_replicas\": 2\n }\n}" indicesCreateRequestExample2: summary: Create an index with mappings. description: You can provide mapping definitions in the create index API requests. value: "{\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"mappings\": {\n \"properties\": {\n \"field1\": { \"type\": \"text\" }\n }\n }\n}" indicesCreateRequestExample3: summary: Create an index with aliases. description: 'You can provide mapping definitions in the create index API requests. Index alias names also support date math. ' value: "{\n \"aliases\": {\n \"alias_1\": {},\n \"alias_2\": {\n \"filter\": {\n \"term\": {\n \"user.id\": \"kimchy\"\n }\n },\n \"routing\": \"shard-1\"\n }\n }\n}" responses: '200': description: '' content: application/json: schema: type: object properties: index: allOf: - $ref: '#/components/schemas/_types.IndexName' shards_acknowledged: type: boolean acknowledged: type: boolean required: - index - shards_acknowledged - acknowledged x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name delete: tags: - indices summary: Delete indices description: 'Deleting an index deletes its documents, shards, and metadata. It does not delete related Kibana components, such as data views, visualizations, or dashboards. You cannot delete the current write index of a data stream. To delete the index, you must roll over the data stream so a new write index is created. You can then use the delete index API to delete the previous write index. ## Required authorization * Index privileges: `delete_index` ' operationId: indices-delete parameters: - in: path name: index description: 'Comma-separated list of indices to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (`*`) or `_all`. To use wildcards or `_all`, set the `action.destructive_requires_name` cluster setting to `false`.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple - in: query name: allow_no_indices description: 'A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.' deprecated: false schema: default: true type: boolean style: form - in: query name: expand_wildcards description: 'Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.' deprecated: false schema: default: open,closed allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form - in: query name: ignore_unavailable description: 'If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.' deprecated: false schema: default: false type: boolean style: form - in: query name: master_timeout 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.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form - in: query name: timeout description: 'Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/_types.IndicesResponseBase' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name head: tags: - indices summary: Check indices description: Check if one or more indices, index aliases, or data streams exist. operationId: indices-exists parameters: - in: path name: index description: Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple - in: query name: allow_no_indices description: 'A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.' deprecated: false schema: default: true type: boolean style: form - in: query name: expand_wildcards description: 'Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.' deprecated: false schema: default: open allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form - in: query name: flat_settings description: If `true`, returns settings in flat format. deprecated: false schema: default: false type: boolean style: form - in: query name: ignore_unavailable description: 'If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.' deprecated: false schema: default: false type: boolean style: form - in: query name: include_defaults description: If `true`, return all default settings in the response. deprecated: false schema: default: false type: boolean style: form - in: query name: local description: If `true`, the request retrieves information from the local node only. deprecated: false schema: default: false type: boolean style: form responses: '200': description: '' content: application/json: {} x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /{index}/_alias/{name}: get: tags: - indices summary: Get aliases description: 'Retrieves information for one or more data stream or index aliases. ## Required authorization * Index privileges: `view_index_metadata` ' operationId: indices-get-alias-2 parameters: - $ref: '#/components/parameters/indices.get_alias-index' - $ref: '#/components/parameters/indices.get_alias-name' - $ref: '#/components/parameters/indices.get_alias-allow_no_indices' - $ref: '#/components/parameters/indices.get_alias-expand_wildcards' - $ref: '#/components/parameters/indices.get_alias-ignore_unavailable' - $ref: '#/components/parameters/indices.get_alias-master_timeout' responses: '200': $ref: '#/components/responses/indices.get_alias-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name put: tags: - indices summary: Create or update an alias description: Adds a data stream or index to an alias. externalDocs: description: Aliases url: https://www.elastic.co/docs/manage-data/data-store/aliases x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-add-alias.html operationId: indices-put-alias parameters: - $ref: '#/components/parameters/indices.put_alias-index' - $ref: '#/components/parameters/indices.put_alias-name' - $ref: '#/components/parameters/indices.put_alias-master_timeout' - $ref: '#/components/parameters/indices.put_alias-timeout' requestBody: $ref: '#/components/requestBodies/indices.put_alias' responses: '200': $ref: '#/components/responses/indices.put_alias-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name post: tags: - indices summary: Create or update an alias description: Adds a data stream or index to an alias. externalDocs: description: Aliases url: https://www.elastic.co/docs/manage-data/data-store/aliases x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-add-alias.html operationId: indices-put-alias-1 parameters: - $ref: '#/components/parameters/indices.put_alias-index' - $ref: '#/components/parameters/indices.put_alias-name' - $ref: '#/components/parameters/indices.put_alias-master_timeout' - $ref: '#/components/parameters/indices.put_alias-timeout' requestBody: $ref: '#/components/requestBodies/indices.put_alias' responses: '200': $ref: '#/components/responses/indices.put_alias-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name delete: tags: - indices summary: Delete an alias description: 'Removes a data stream or index from an alias. ## Required authorization * Index privileges: `manage` ' operationId: indices-delete-alias parameters: - $ref: '#/components/parameters/indices.delete_alias-index' - $ref: '#/components/parameters/indices.delete_alias-name' - $ref: '#/components/parameters/indices.delete_alias-master_timeout' - $ref: '#/components/parameters/indices.delete_alias-timeout' responses: '200': $ref: '#/components/responses/indices.delete_alias-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name head: tags: - indices summary: Check aliases description: Check if one or more data stream or index aliases exist. operationId: indices-exists-alias-1 parameters: - $ref: '#/components/parameters/indices.exists_alias-index' - $ref: '#/components/parameters/indices.exists_alias-name' - $ref: '#/components/parameters/indices.exists_alias-allow_no_indices' - $ref: '#/components/parameters/indices.exists_alias-expand_wildcards' - $ref: '#/components/parameters/indices.exists_alias-ignore_unavailable' - $ref: '#/components/parameters/indices.exists_alias-master_timeout' responses: '200': $ref: '#/components/responses/indices.exists_alias-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /{index}/_aliases/{name}: put: tags: - indices summary: Create or update an alias description: Adds a data stream or index to an alias. externalDocs: description: Aliases url: https://www.elastic.co/docs/manage-data/data-store/aliases x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-add-alias.html operationId: indices-put-alias-2 parameters: - $ref: '#/components/parameters/indices.put_alias-index' - $ref: '#/components/parameters/indices.put_alias-name' - $ref: '#/components/parameters/indices.put_alias-master_timeout' - $ref: '#/components/parameters/indices.put_alias-timeout' requestBody: $ref: '#/components/requestBodies/indices.put_alias' responses: '200': $ref: '#/components/responses/indices.put_alias-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name post: tags: - indices summary: Create or update an alias description: Adds a data stream or index to an alias. externalDocs: description: Aliases url: https://www.elastic.co/docs/manage-data/data-store/aliases x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-add-alias.html operationId: indices-put-alias-3 parameters: - $ref: '#/components/parameters/indices.put_alias-index' - $ref: '#/components/parameters/indices.put_alias-name' - $ref: '#/components/parameters/indices.put_alias-master_timeout' - $ref: '#/components/parameters/indices.put_alias-timeout' requestBody: $ref: '#/components/requestBodies/indices.put_alias' responses: '200': $ref: '#/components/responses/indices.put_alias-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name delete: tags: - indices summary: Delete an alias description: 'Removes a data stream or index from an alias. ## Required authorization * Index privileges: `manage` ' operationId: indices-delete-alias-1 parameters: - $ref: '#/components/parameters/indices.delete_alias-index' - $ref: '#/components/parameters/indices.delete_alias-name' - $ref: '#/components/parameters/indices.delete_alias-master_timeout' - $ref: '#/components/parameters/indices.delete_alias-timeout' responses: '200': $ref: '#/components/responses/indices.delete_alias-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /_data_stream/{name}/_lifecycle: delete: tags: - indices summary: Delete data stream lifecycles description: Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. externalDocs: description: About data stream lifecycle url: https://www.elastic.co/docs/manage-data/lifecycle/data-stream x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/data-streams-delete-lifecycle.html operationId: indices-delete-data-lifecycle parameters: - in: path name: name description: 'A comma-separated list of data streams of which the data stream lifecycle will be deleted. Use `*` to get all data streams' required: true deprecated: false schema: $ref: '#/components/schemas/_types.DataStreamNames' style: simple - in: query name: expand_wildcards description: 'Whether wildcard expressions should get expanded to open or closed indices (default: open)' deprecated: false schema: default: open allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form - in: query name: master_timeout description: The period to wait for a connection to the master node. deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form - in: query name: timeout description: The period to wait for a response. deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/_types.AcknowledgedResponseBase' examples: IndicesDeleteDataLifecycleResponseExample1: description: A successful response for deleting a data stream lifecycle. value: "{\n \"acknowledged\": true\n}" x-state: Generally available; Added in 8.11.0 x-metaTags: - content: Elasticsearch name: product_name /_index_template/{name}: get: tags: - indices summary: Get index templates description: 'Get information about one or more index templates. ## Required authorization * Cluster privileges: `manage_index_templates` ' operationId: indices-get-index-template-1 parameters: - $ref: '#/components/parameters/indices.get_index_template-name' - $ref: '#/components/parameters/indices.get_index_template-local' - $ref: '#/components/parameters/indices.get_index_template-flat_settings' - $ref: '#/components/parameters/indices.get_index_template-master_timeout' - $ref: '#/components/parameters/indices.get_index_template-include_defaults' responses: '200': $ref: '#/components/responses/indices.get_index_template-200' x-state: Generally available; Added in 7.9.0 x-metaTags: - content: Elasticsearch name: product_name put: tags: - indices summary: Create or update an index template description: 'Index templates define settings, mappings, and aliases that can be applied automatically to new indices. Elasticsearch applies templates to new indices based on an wildcard pattern that matches the index name. Index templates are applied during data stream or index creation. For data streams, these settings and mappings are applied when the stream''s backing indices are created. Settings and mappings specified in a create index API request override any settings or mappings specified in an index template. Changes to index templates do not affect existing indices, including the existing backing indices of a data stream. You can use C-style `/* *\/` block comments in index templates. You can include comments anywhere in the request body, except before the opening curly bracket. **Multiple matching templates** If multiple index templates match the name of a new index or data stream, the template with the highest priority is used. Multiple 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. **Composing aliases, mappings, and settings** When 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. Any mappings, settings, or aliases from the parent index template are merged in next. Finally, any configuration on the index request itself is merged. Mapping definitions are merged recursively, which means that later mapping components can introduce new field mappings and update the mapping configuration. If a field mapping is already contained in an earlier component, its definition will be completely overwritten by the later one. This recursive merging strategy applies not only to field mappings, but also root options like `dynamic_templates` and `meta`. If an earlier component contains a `dynamic_templates` block, then by default new `dynamic_templates` entries are appended onto the end. If an entry already exists with the same key, then it is overwritten by the new definition. ## Required authorization * Cluster privileges: `manage_index_templates` ' operationId: indices-put-index-template parameters: - $ref: '#/components/parameters/indices.put_index_template-name' - $ref: '#/components/parameters/indices.put_index_template-create' - $ref: '#/components/parameters/indices.put_index_template-master_timeout' - $ref: '#/components/parameters/indices.put_index_template-cause' requestBody: $ref: '#/components/requestBodies/indices.put_index_template' responses: '200': $ref: '#/components/responses/indices.put_index_template-200' x-state: Generally available; Added in 7.9.0 x-metaTags: - content: Elasticsearch name: product_name post: tags: - indices summary: Create or update an index template description: 'Index templates define settings, mappings, and aliases that can be applied automatically to new indices. Elasticsearch applies templates to new indices based on an wildcard pattern that matches the index name. Index templates are applied during data stream or index creation. For data streams, these settings and mappings are applied when the stream''s backing indices are created. Settings and mappings specified in a create index API request override any settings or mappings specified in an index template. Changes to index templates do not affect existing indices, including the existing backing indices of a data stream. You can use C-style `/* *\/` block comments in index templates. You can include comments anywhere in the request body, except before the opening curly bracket. **Multiple matching templates** If multiple index templates match the name of a new index or data stream, the template with the highest priority is used. Multiple 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. **Composing aliases, mappings, and settings** When 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. Any mappings, settings, or aliases from the parent index template are merged in next. Finally, any configuration on the index request itself is merged. Mapping definitions are merged recursively, which means that later mapping components can introduce new field mappings and update the mapping configuration. If a field mapping is already contained in an earlier component, its definition will be completely overwritten by the later one. This recursive merging strategy applies not only to field mappings, but also root options like `dynamic_templates` and `meta`. If an earlier component contains a `dynamic_templates` block, then by default new `dynamic_templates` entries are appended onto the end. If an entry already exists with the same key, then it is overwritten by the new definition. ## Required authorization * Cluster privileges: `manage_index_templates` ' operationId: indices-put-index-template-1 parameters: - $ref: '#/components/parameters/indices.put_index_template-name' - $ref: '#/components/parameters/indices.put_index_template-create' - $ref: '#/components/parameters/indices.put_index_template-master_timeout' - $ref: '#/components/parameters/indices.put_index_template-cause' requestBody: $ref: '#/components/requestBodies/indices.put_index_template' responses: '200': $ref: '#/components/responses/indices.put_index_template-200' x-state: Generally available; Added in 7.9.0 x-metaTags: - content: Elasticsearch name: product_name delete: tags: - indices summary: Delete an index template description: 'The provided may contain multiple template names separated by a comma. If multiple template names are specified then there is no wildcard support and the provided names should match completely with existing templates. ## Required authorization * Cluster privileges: `manage_index_templates` ' operationId: indices-delete-index-template parameters: - in: path name: name description: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. required: true deprecated: false schema: $ref: '#/components/schemas/_types.Names' style: simple - in: query name: master_timeout 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. deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form - in: query name: timeout description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/_types.AcknowledgedResponseBase' x-state: Generally available; Added in 7.8.0 x-metaTags: - content: Elasticsearch name: product_name head: tags: - indices summary: Check index templates description: 'Check whether index templates exist. ## Required authorization * Cluster privileges: `manage_index_templates` ' operationId: indices-exists-index-template parameters: - in: path name: name description: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. required: true deprecated: false schema: $ref: '#/components/schemas/_types.Name' style: simple - in: query name: local description: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. deprecated: false schema: default: false type: boolean style: form - in: query name: flat_settings description: If true, returns settings in flat format. deprecated: false schema: default: false type: boolean style: form - in: query name: master_timeout 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. deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: {} x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /_template/{name}: get: tags: - indices summary: Get legacy index templates description: 'Get information about one or more index templates. IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. ## Required authorization * Cluster privileges: `manage_index_templates` ' externalDocs: description: Learn more about templates url: https://www.elastic.co/docs/manage-data/data-store/templates x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-get-template-v1.html operationId: indices-get-template-1 parameters: - $ref: '#/components/parameters/indices.get_template-name' - $ref: '#/components/parameters/indices.get_template-flat_settings' - $ref: '#/components/parameters/indices.get_template-local' - $ref: '#/components/parameters/indices.get_template-master_timeout' responses: '200': $ref: '#/components/responses/indices.get_template-200' deprecated: true x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name put: tags: - indices summary: Create or update a legacy index template description: 'Index templates define settings, mappings, and aliases that can be applied automatically to new indices. Elasticsearch applies templates to new indices based on an index pattern that matches the index name. IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. Composable templates always take precedence over legacy templates. If no composable template matches a new index, matching legacy templates are applied according to their order. Index templates are only applied during index creation. Changes to index templates do not affect existing indices. Settings and mappings specified in create index API requests override any settings or mappings specified in an index template. You can use C-style `/* *\/` block comments in index templates. You can include comments anywhere in the request body, except before the opening curly bracket. **Indices matching multiple templates** Multiple index templates can potentially match an index, in this case, both the settings and mappings are merged into the final configuration of the index. The order of the merging can be controlled using the order parameter, with lower order being applied first, and higher orders overriding them. NOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order. ## Required authorization * Cluster privileges: `manage_index_templates`,`manage` ' externalDocs: description: Learn more about templates url: https://www.elastic.co/docs/manage-data/data-store/templates x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-templates-v1.html operationId: indices-put-template parameters: - $ref: '#/components/parameters/indices.put_template-name' - $ref: '#/components/parameters/indices.put_template-create' - $ref: '#/components/parameters/indices.put_template-master_timeout' - $ref: '#/components/parameters/indices.put_template-order' - $ref: '#/components/parameters/indices.put_template-cause' requestBody: $ref: '#/components/requestBodies/indices.put_template' responses: '200': $ref: '#/components/responses/indices.put_template-200' deprecated: true x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name post: tags: - indices summary: Create or update a legacy index template description: 'Index templates define settings, mappings, and aliases that can be applied automatically to new indices. Elasticsearch applies templates to new indices based on an index pattern that matches the index name. IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. Composable templates always take precedence over legacy templates. If no composable template matches a new index, matching legacy templates are applied according to their order. Index templates are only applied during index creation. Changes to index templates do not affect existing indices. Settings and mappings specified in create index API requests override any settings or mappings specified in an index template. You can use C-style `/* *\/` block comments in index templates. You can include comments anywhere in the request body, except before the opening curly bracket. **Indices matching multiple templates** Multiple index templates can potentially match an index, in this case, both the settings and mappings are merged into the final configuration of the index. The order of the merging can be controlled using the order parameter, with lower order being applied first, and higher orders overriding them. NOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order. ## Required authorization * Cluster privileges: `manage_index_templates`,`manage` ' externalDocs: description: Learn more about templates url: https://www.elastic.co/docs/manage-data/data-store/templates x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-templates-v1.html operationId: indices-put-template-1 parameters: - $ref: '#/components/parameters/indices.put_template-name' - $ref: '#/components/parameters/indices.put_template-create' - $ref: '#/components/parameters/indices.put_template-master_timeout' - $ref: '#/components/parameters/indices.put_template-order' - $ref: '#/components/parameters/indices.put_template-cause' requestBody: $ref: '#/components/requestBodies/indices.put_template' responses: '200': $ref: '#/components/responses/indices.put_template-200' deprecated: true x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name delete: tags: - indices summary: Delete a legacy index template description: 'IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. ## Required authorization * Cluster privileges: `manage_index_templates` ' operationId: indices-delete-template parameters: - in: path name: name description: 'The name of the legacy index template to delete. Wildcard (`*`) expressions are supported.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Name' style: simple - in: query name: master_timeout 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.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form - in: query name: timeout description: 'Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/_types.AcknowledgedResponseBase' deprecated: true x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name head: tags: - indices summary: Check existence of index templates description: 'Get information about whether index templates exist. Index templates define settings, mappings, and aliases that can be applied automatically to new indices. IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. ## Required authorization * Cluster privileges: `manage_index_templates` ' externalDocs: description: Learn more about templates url: https://www.elastic.co/docs/manage-data/data-store/templates x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-template-exists-v1.html operationId: indices-exists-template parameters: - in: path name: name description: 'A comma-separated list of index template names used to limit the request. Wildcard (`*`) expressions are supported.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Names' style: simple - in: query name: flat_settings description: Indicates whether to use a flat format for the response. deprecated: false schema: default: false type: boolean style: form - in: query name: local description: Indicates whether to get information from the local node only. deprecated: true schema: default: false type: boolean style: form - in: query name: master_timeout description: 'The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form responses: '200': description: '' content: application/json: {} x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /{index}/_disk_usage: post: tags: - indices summary: Analyze the index disk usage description: 'Analyze the disk usage of each field of an index or data stream. This API might not support indices created in previous Elasticsearch versions. The result of a small index can be inaccurate as some parts of an index might not be analyzed by the API. NOTE: The total size of fields of the analyzed shards of the index in the response is usually smaller than the index `store_size` value because some small metadata files are ignored and some parts of data files might not be scanned by the API. Since stored fields are stored together in a compressed format, the sizes of stored fields are also estimates and can be inaccurate. The stored size of the `_id` field is likely underestimated while the `_source` field is overestimated. For usage examples see the External documentation or refer to [Analyze the index disk usage example](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/index-disk-usage) for an example.' externalDocs: description: About analyzing index disk usage url: https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-disk-usage x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-disk-usage.html operationId: indices-disk-usage parameters: - in: path name: index description: 'Comma-separated list of data streams, indices, and aliases used to limit the request. It’s recommended to execute this API with a single index (or the latest backing index of a data stream) as the API consumes resources significantly.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple - in: query name: allow_no_indices description: 'A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.' deprecated: false schema: default: true type: boolean style: form - in: query name: expand_wildcards description: 'Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.' deprecated: false schema: default: open allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form - in: query name: flush description: 'If `true`, the API performs a flush before analysis. If `false`, the response may not include uncommitted data.' deprecated: false schema: default: true type: boolean style: form - in: query name: ignore_unavailable description: 'If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.' deprecated: false schema: default: false type: boolean style: form - in: query name: run_expensive_tasks description: 'Analyzing field disk usage is resource-intensive. To use the API, this parameter must be set to `true`.' deprecated: false schema: default: false type: boolean style: form responses: '200': description: '' content: application/json: schema: type: object examples: IndicesDiskUsageResponseExample1: description: An abbreviated response from `POST /my-index-000001/_disk_usage?run_expensive_tasks=true`. value: "{\n \"_shards\": {\n \"total\": 1,\n \"successful\": 1,\n \"failed\": 0\n },\n \"my-index-000001\": {\n \"store_size\": \"929mb\",\n \"store_size_in_bytes\": 974192723,\n \"all_fields\": {\n \"total\": \"928.9mb\",\n \"total_in_bytes\": 973977084,\n \"inverted_index\": {\n \"total\": \"107.8mb\",\n \"total_in_bytes\": 113128526\n },\n \"stored_fields\": \"623.5mb\",\n \"stored_fields_in_bytes\": 653819143,\n \"doc_values\": \"125.7mb\",\n \"doc_values_in_bytes\": 131885142,\n \"points\": \"59.9mb\",\n \"points_in_bytes\": 62885773,\n \"norms\": \"2.3kb\",\n \"norms_in_bytes\": 2356,\n \"term_vectors\": \"2.2kb\",\n \"term_vectors_in_bytes\": 2310,\n \"knn_vectors\": \"0b\",\n \"knn_vectors_in_bytes\": 0\n },\n \"fields\": {\n \"_id\": {\n \"total\": \"49.3mb\",\n \"total_in_bytes\": 51709993,\n \"inverted_index\": {\n \"total\": \"29.7mb\",\n \"total_in_bytes\": 31172745\n },\n \"stored_fields\": \"19.5mb\",\n \"stored_fields_in_bytes\": 20537248,\n \"doc_values\": \"0b\",\n \"doc_values_in_bytes\": 0,\n \"points\": \"0b\",\n \"points_in_bytes\": 0,\n \"norms\": \"0b\",\n \"norms_in_bytes\": 0,\n \"term_vectors\": \"0b\",\n \"term_vectors_in_bytes\": 0,\n \"knn_vectors\": \"0b\",\n \"knn_vectors_in_bytes\": 0\n },\n \"_primary_term\": {},\n \"_seq_no\": {},\n \"_version\": {},\n \"_source\": {\n \"total\": \"603.9mb\",\n \"total_in_bytes\": 633281895,\n \"inverted_index\": {},\n \"stored_fields\": \"603.9mb\",\n \"stored_fields_in_bytes\": 633281895,\n \"doc_values\": \"0b\",\n \"doc_values_in_bytes\": 0,\n \"points\": \"0b\",\n \"points_in_bytes\": 0,\n \"norms\": \"0b\",\n \"norms_in_bytes\": 0,\n \"term_vectors\": \"0b\",\n \"term_vectors_in_bytes\": 0,\n \"knn_vectors\": \"0b\",\n \"knn_vectors_in_bytes\": 0\n },\n \"context\": {\n \"total\": \"28.6mb\",\n \"total_in_bytes\": 30060405,\n \"inverted_index\": {\n \"total\": \"22mb\",\n \"total_in_bytes\": 23090908\n },\n \"stored_fields\": \"0b\",\n \"stored_fields_in_bytes\": 0,\n \"doc_values\": \"0b\",\n \"doc_values_in_bytes\": 0,\n \"points\": \"0b\",\n \"points_in_bytes\": 0,\n \"norms\": \"2.3kb\",\n \"norms_in_bytes\": 2356,\n \"term_vectors\": \"2.2kb\",\n \"term_vectors_in_bytes\": 2310,\n \"knn_vectors\": \"0b\",\n \"knn_vectors_in_bytes\": 0\n },\n \"context.keyword\": {},\n \"message\": {},\n \"message.keyword\": {}\n }\n }\n}" x-state: Experimental; Added in 7.15.0 x-metaTags: - content: Elasticsearch name: product_name /_alias/{name}: get: tags: - indices summary: Get aliases description: 'Retrieves information for one or more data stream or index aliases. ## Required authorization * Index privileges: `view_index_metadata` ' operationId: indices-get-alias-1 parameters: - $ref: '#/components/parameters/indices.get_alias-name' - $ref: '#/components/parameters/indices.get_alias-allow_no_indices' - $ref: '#/components/parameters/indices.get_alias-expand_wildcards' - $ref: '#/components/parameters/indices.get_alias-ignore_unavailable' - $ref: '#/components/parameters/indices.get_alias-master_timeout' responses: '200': $ref: '#/components/responses/indices.get_alias-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name head: tags: - indices summary: Check aliases description: Check if one or more data stream or index aliases exist. operationId: indices-exists-alias parameters: - $ref: '#/components/parameters/indices.exists_alias-name' - $ref: '#/components/parameters/indices.exists_alias-allow_no_indices' - $ref: '#/components/parameters/indices.exists_alias-expand_wildcards' - $ref: '#/components/parameters/indices.exists_alias-ignore_unavailable' - $ref: '#/components/parameters/indices.exists_alias-master_timeout' responses: '200': $ref: '#/components/responses/indices.exists_alias-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /{index}/_field_usage_stats: get: tags: - indices summary: Get field usage stats description: 'Get field usage information for each shard and field of an index. Field usage statistics are automatically captured when queries are running on a cluster. A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use. The response body reports the per-shard usage count of the data structures that back the fields in the index. A given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times. ## Required authorization * Index privileges: `manage` ' operationId: indices-field-usage-stats parameters: - in: path name: index description: Comma-separated list or wildcard expression of index names used to limit the request. required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple - in: query name: allow_no_indices description: 'A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.' deprecated: false schema: type: boolean style: form - in: query name: expand_wildcards description: 'Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.' deprecated: false schema: default: open allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form - in: query name: ignore_unavailable description: 'If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.' deprecated: false schema: default: false type: boolean style: form - in: query name: fields description: Comma-separated list or wildcard expressions of fields to include in the statistics. deprecated: false schema: $ref: '#/components/schemas/_types.Fields' style: form responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/indices.field_usage_stats.FieldsUsageBody' examples: indicesFieldUsageStatsResponseExample1: description: 'An abbreviated response from `GET /my-index-000001/_field_usage_stats`. The `all_fields` object reports the sums of the usage counts for all fields in the index (on the listed shard). ' value: "{\n \"_shards\": {\n \"total\": 1,\n \"successful\": 1,\n \"failed\": 0\n },\n \"my-index-000001\": {\n \"shards\": [\n {\n \"tracking_id\": \"MpOl0QlTQ4SYYhEe6KgJoQ\",\n \"tracking_started_at_millis\": 1625558985010,\n \"routing\": {\n \"state\": \"STARTED\",\n \"primary\": true,\n \"node\": \"gA6KeeVzQkGURFCUyV-e8Q\",\n \"relocating_node\": null\n },\n \"stats\": {\n \"all_fields\": {\n \"any\": \"6\",\n \"inverted_index\": {\n \"terms\": 1,\n \"postings\": 1,\n \"proximity\": 1,\n \"positions\": 0,\n \"term_frequencies\": 1,\n \"offsets\": 0,\n \"payloads\": 0\n },\n \"stored_fields\": 2,\n \"doc_values\": 1,\n \"points\": 0,\n \"norms\": 1,\n \"term_vectors\": 0,\n \"knn_vectors\": 0\n },\n \"fields\": {\n \"_id\": {\n \"any\": 1,\n \"inverted_index\": {\n \"terms\": 1,\n \"postings\": 1,\n \"proximity\": 1,\n \"positions\": 0,\n \"term_frequencies\": 1,\n \"offsets\": 0,\n \"payloads\": 0\n },\n \"stored_fields\": 1,\n \"doc_values\": 0,\n \"points\": 0,\n \"norms\": 0,\n \"term_vectors\": 0,\n \"knn_vectors\": 0\n },\n \"_source\": {},\n \"context\": {},\n \"message.keyword\": {}\n }\n }\n }\n ]\n }\n}" x-state: Experimental; Added in 7.15.0 x-metaTags: - content: Elasticsearch name: product_name /_flush: get: tags: - indices summary: Flush data streams or indices description: 'Flushing 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. When 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. Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. After each operation has been flushed it is permanently stored in the Lucene index. This may mean that there is no need to maintain an additional copy of it in the transaction log. The 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. It 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. If 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. ## Required authorization * Index privileges: `maintenance` ' operationId: indices-flush-1 parameters: - $ref: '#/components/parameters/indices.flush-allow_no_indices' - $ref: '#/components/parameters/indices.flush-expand_wildcards' - $ref: '#/components/parameters/indices.flush-force' - $ref: '#/components/parameters/indices.flush-ignore_unavailable' - $ref: '#/components/parameters/indices.flush-wait_if_ongoing' responses: '200': $ref: '#/components/responses/indices.flush-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name post: tags: - indices summary: Flush data streams or indices description: 'Flushing 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. When 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. Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. After each operation has been flushed it is permanently stored in the Lucene index. This may mean that there is no need to maintain an additional copy of it in the transaction log. The 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. It 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. If 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. ## Required authorization * Index privileges: `maintenance` ' operationId: indices-flush parameters: - $ref: '#/components/parameters/indices.flush-allow_no_indices' - $ref: '#/components/parameters/indices.flush-expand_wildcards' - $ref: '#/components/parameters/indices.flush-force' - $ref: '#/components/parameters/indices.flush-ignore_unavailable' - $ref: '#/components/parameters/indices.flush-wait_if_ongoing' responses: '200': $ref: '#/components/responses/indices.flush-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /{index}/_flush: get: tags: - indices summary: Flush data streams or indices description: 'Flushing 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. When 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. Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. After each operation has been flushed it is permanently stored in the Lucene index. This may mean that there is no need to maintain an additional copy of it in the transaction log. The 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. It 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. If 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. ## Required authorization * Index privileges: `maintenance` ' operationId: indices-flush-3 parameters: - $ref: '#/components/parameters/indices.flush-index' - $ref: '#/components/parameters/indices.flush-allow_no_indices' - $ref: '#/components/parameters/indices.flush-expand_wildcards' - $ref: '#/components/parameters/indices.flush-force' - $ref: '#/components/parameters/indices.flush-ignore_unavailable' - $ref: '#/components/parameters/indices.flush-wait_if_ongoing' responses: '200': $ref: '#/components/responses/indices.flush-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name post: tags: - indices summary: Flush data streams or indices description: 'Flushing 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. When 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. Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. After each operation has been flushed it is permanently stored in the Lucene index. This may mean that there is no need to maintain an additional copy of it in the transaction log. The 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. It 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. If 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. ## Required authorization * Index privileges: `maintenance` ' operationId: indices-flush-2 parameters: - $ref: '#/components/parameters/indices.flush-index' - $ref: '#/components/parameters/indices.flush-allow_no_indices' - $ref: '#/components/parameters/indices.flush-expand_wildcards' - $ref: '#/components/parameters/indices.flush-force' - $ref: '#/components/parameters/indices.flush-ignore_unavailable' - $ref: '#/components/parameters/indices.flush-wait_if_ongoing' responses: '200': $ref: '#/components/responses/indices.flush-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /_forcemerge: post: tags: - indices summary: Force a merge description: 'Perform the force merge operation on the shards of one or more indices. For data streams, the API forces a merge on the shards of the stream''s backing indices. Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". These soft-deleted documents are automatically cleaned up during regular segment merges. But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. If 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. **Blocks during a force merge** Calls to this API block until the merge is complete (unless request contains `wait_for_completion=false`). If the client connection is lost before completion then the force merge process will continue in the background. Any new requests to force merge the same indices will also block until the ongoing force merge is complete. **Running force merge asynchronously** If 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. However, you can not cancel this task as the force merge task is not cancelable. Elasticsearch creates a record of this task as a document at `_tasks/`. **Force merging multiple indices** You can force merge multiple indices with a single request by targeting: * One or more data streams that contain multiple backing indices * Multiple indices * One or more aliases * All data streams and indices in a cluster Each targeted shard is force-merged separately using the `force_merge` threadpool. The `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. If you expand the `force_merge` threadpool on a node then it will force merge its shards with more parallelism. Force 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. **Data streams and time-based indices** Force-merging is useful for managing a data stream''s older backing indices and other time-based indices, particularly after a rollover. In these cases, each index only receives indexing traffic for a certain period of time. Once an index receive no more writes, its shards can be force-merged to a single segment. This can be a good idea because single-segment shards can sometimes use simpler and more efficient data structures to perform searches. For example: ``` POST /.ds-my-data-stream-2099.03.07-000001/_forcemerge?max_num_segments=1 ``` ## Required authorization * Index privileges: `maintenance` ' externalDocs: description: More about merge settings url: https://www.elastic.co/docs/reference/elasticsearch/index-settings/merge x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-forcemerge.html operationId: indices-forcemerge parameters: - $ref: '#/components/parameters/indices.forcemerge-allow_no_indices' - $ref: '#/components/parameters/indices.forcemerge-expand_wildcards' - $ref: '#/components/parameters/indices.forcemerge-flush' - $ref: '#/components/parameters/indices.forcemerge-ignore_unavailable' - $ref: '#/components/parameters/indices.forcemerge-max_num_segments' - $ref: '#/components/parameters/indices.forcemerge-only_expunge_deletes' - $ref: '#/components/parameters/indices.forcemerge-wait_for_completion' responses: '200': $ref: '#/components/responses/indices.forcemerge-200' x-state: Generally available; Added in 2.1.0 x-metaTags: - content: Elasticsearch name: product_name /{index}/_forcemerge: post: tags: - indices summary: Force a merge description: 'Perform the force merge operation on the shards of one or more indices. For data streams, the API forces a merge on the shards of the stream''s backing indices. Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". These soft-deleted documents are automatically cleaned up during regular segment merges. But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. If 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. **Blocks during a force merge** Calls to this API block until the merge is complete (unless request contains `wait_for_completion=false`). If the client connection is lost before completion then the force merge process will continue in the background. Any new requests to force merge the same indices will also block until the ongoing force merge is complete. **Running force merge asynchronously** If 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. However, you can not cancel this task as the force merge task is not cancelable. Elasticsearch creates a record of this task as a document at `_tasks/`. **Force merging multiple indices** You can force merge multiple indices with a single request by targeting: * One or more data streams that contain multiple backing indices * Multiple indices * One or more aliases * All data streams and indices in a cluster Each targeted shard is force-merged separately using the `force_merge` threadpool. The `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. If you expand the `force_merge` threadpool on a node then it will force merge its shards with more parallelism. Force 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. **Data streams and time-based indices** Force-merging is useful for managing a data stream''s older backing indices and other time-based indices, particularly after a rollover. In these cases, each index only receives indexing traffic for a certain period of time. Once an index receive no more writes, its shards can be force-merged to a single segment. This can be a good idea because single-segment shards can sometimes use simpler and more efficient data structures to perform searches. For example: ``` POST /.ds-my-data-stream-2099.03.07-000001/_forcemerge?max_num_segments=1 ``` ## Required authorization * Index privileges: `maintenance` ' externalDocs: description: More about merge settings url: https://www.elastic.co/docs/reference/elasticsearch/index-settings/merge x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-forcemerge.html operationId: indices-forcemerge-1 parameters: - $ref: '#/components/parameters/indices.forcemerge-index' - $ref: '#/components/parameters/indices.forcemerge-allow_no_indices' - $ref: '#/components/parameters/indices.forcemerge-expand_wildcards' - $ref: '#/components/parameters/indices.forcemerge-flush' - $ref: '#/components/parameters/indices.forcemerge-ignore_unavailable' - $ref: '#/components/parameters/indices.forcemerge-max_num_segments' - $ref: '#/components/parameters/indices.forcemerge-only_expunge_deletes' - $ref: '#/components/parameters/indices.forcemerge-wait_for_completion' responses: '200': $ref: '#/components/responses/indices.forcemerge-200' x-state: Generally available; Added in 2.1.0 x-metaTags: - content: Elasticsearch name: product_name /_alias: get: tags: - indices summary: Get aliases description: 'Retrieves information for one or more data stream or index aliases. ## Required authorization * Index privileges: `view_index_metadata` ' operationId: indices-get-alias parameters: - $ref: '#/components/parameters/indices.get_alias-allow_no_indices' - $ref: '#/components/parameters/indices.get_alias-expand_wildcards' - $ref: '#/components/parameters/indices.get_alias-ignore_unavailable' - $ref: '#/components/parameters/indices.get_alias-master_timeout' responses: '200': $ref: '#/components/responses/indices.get_alias-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /{index}/_alias: get: tags: - indices summary: Get aliases description: 'Retrieves information for one or more data stream or index aliases. ## Required authorization * Index privileges: `view_index_metadata` ' operationId: indices-get-alias-3 parameters: - $ref: '#/components/parameters/indices.get_alias-index' - $ref: '#/components/parameters/indices.get_alias-allow_no_indices' - $ref: '#/components/parameters/indices.get_alias-expand_wildcards' - $ref: '#/components/parameters/indices.get_alias-ignore_unavailable' - $ref: '#/components/parameters/indices.get_alias-master_timeout' responses: '200': $ref: '#/components/responses/indices.get_alias-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /_mapping/field/{fields}: get: tags: - indices summary: Get mapping definitions description: 'Retrieves mapping definitions for one or more fields. For data streams, the API retrieves field mappings for the stream’s backing indices. This API is useful if you don''t need a complete mapping or if an index mapping contains a large number of fields. ## Required authorization * Index privileges: `view_index_metadata` ' operationId: indices-get-field-mapping parameters: - $ref: '#/components/parameters/indices.get_field_mapping-fields' - $ref: '#/components/parameters/indices.get_field_mapping-allow_no_indices' - $ref: '#/components/parameters/indices.get_field_mapping-expand_wildcards' - $ref: '#/components/parameters/indices.get_field_mapping-ignore_unavailable' - $ref: '#/components/parameters/indices.get_field_mapping-include_defaults' responses: '200': $ref: '#/components/responses/indices.get_field_mapping-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /{index}/_mapping/field/{fields}: get: tags: - indices summary: Get mapping definitions description: 'Retrieves mapping definitions for one or more fields. For data streams, the API retrieves field mappings for the stream’s backing indices. This API is useful if you don''t need a complete mapping or if an index mapping contains a large number of fields. ## Required authorization * Index privileges: `view_index_metadata` ' operationId: indices-get-field-mapping-1 parameters: - $ref: '#/components/parameters/indices.get_field_mapping-index' - $ref: '#/components/parameters/indices.get_field_mapping-fields' - $ref: '#/components/parameters/indices.get_field_mapping-allow_no_indices' - $ref: '#/components/parameters/indices.get_field_mapping-expand_wildcards' - $ref: '#/components/parameters/indices.get_field_mapping-ignore_unavailable' - $ref: '#/components/parameters/indices.get_field_mapping-include_defaults' responses: '200': $ref: '#/components/responses/indices.get_field_mapping-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /_index_template: get: tags: - indices summary: Get index templates description: 'Get information about one or more index templates. ## Required authorization * Cluster privileges: `manage_index_templates` ' operationId: indices-get-index-template parameters: - $ref: '#/components/parameters/indices.get_index_template-local' - $ref: '#/components/parameters/indices.get_index_template-flat_settings' - $ref: '#/components/parameters/indices.get_index_template-master_timeout' - $ref: '#/components/parameters/indices.get_index_template-include_defaults' responses: '200': $ref: '#/components/responses/indices.get_index_template-200' x-state: Generally available; Added in 7.9.0 x-metaTags: - content: Elasticsearch name: product_name /_mapping: get: tags: - indices summary: Get mapping definitions description: 'For data streams, the API retrieves mappings for the stream’s backing indices. ## Required authorization * Index privileges: `view_index_metadata` ' operationId: indices-get-mapping parameters: - $ref: '#/components/parameters/indices.get_mapping-allow_no_indices' - $ref: '#/components/parameters/indices.get_mapping-expand_wildcards' - $ref: '#/components/parameters/indices.get_mapping-ignore_unavailable' - $ref: '#/components/parameters/indices.get_mapping-local' - $ref: '#/components/parameters/indices.get_mapping-master_timeout' responses: '200': $ref: '#/components/responses/indices.get_mapping-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /{index}/_mapping: get: tags: - indices summary: Get mapping definitions description: 'For data streams, the API retrieves mappings for the stream’s backing indices. ## Required authorization * Index privileges: `view_index_metadata` ' operationId: indices-get-mapping-1 parameters: - $ref: '#/components/parameters/indices.get_mapping-index' - $ref: '#/components/parameters/indices.get_mapping-allow_no_indices' - $ref: '#/components/parameters/indices.get_mapping-expand_wildcards' - $ref: '#/components/parameters/indices.get_mapping-ignore_unavailable' - $ref: '#/components/parameters/indices.get_mapping-local' - $ref: '#/components/parameters/indices.get_mapping-master_timeout' responses: '200': $ref: '#/components/responses/indices.get_mapping-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name put: tags: - indices summary: Update field mappings description: 'Add new fields to an existing data stream or index. You can use the update mapping API to: - Add a new field to an existing index - Update mappings for multiple indices in a single request - Add new properties to an object field - Enable multi-fields for an existing field - Update supported mapping parameters - Change a field''s mapping using reindexing - Rename a field using a field alias Learn how to use the update mapping API with practical examples in the [Update mapping API examples](https://www.elastic.co/docs/manage-data/data-store/mapping/update-mappings-examples) guide. ## Required authorization * Index privileges: `manage` ' externalDocs: description: More about mapping parameters url: https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-parameters x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-put-mapping.html operationId: indices-put-mapping parameters: - $ref: '#/components/parameters/indices.put_mapping-index' - $ref: '#/components/parameters/indices.put_mapping-allow_no_indices' - $ref: '#/components/parameters/indices.put_mapping-expand_wildcards' - $ref: '#/components/parameters/indices.put_mapping-ignore_unavailable' - $ref: '#/components/parameters/indices.put_mapping-master_timeout' - $ref: '#/components/parameters/indices.put_mapping-timeout' - $ref: '#/components/parameters/indices.put_mapping-write_index_only' requestBody: $ref: '#/components/requestBodies/indices.put_mapping' responses: '200': $ref: '#/components/responses/indices.put_mapping-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name post: tags: - indices summary: Update field mappings description: 'Add new fields to an existing data stream or index. You can use the update mapping API to: - Add a new field to an existing index - Update mappings for multiple indices in a single request - Add new properties to an object field - Enable multi-fields for an existing field - Update supported mapping parameters - Change a field''s mapping using reindexing - Rename a field using a field alias Learn how to use the update mapping API with practical examples in the [Update mapping API examples](https://www.elastic.co/docs/manage-data/data-store/mapping/update-mappings-examples) guide. ## Required authorization * Index privileges: `manage` ' externalDocs: description: More about mapping parameters url: https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/mapping-parameters x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-put-mapping.html operationId: indices-put-mapping-1 parameters: - $ref: '#/components/parameters/indices.put_mapping-index' - $ref: '#/components/parameters/indices.put_mapping-allow_no_indices' - $ref: '#/components/parameters/indices.put_mapping-expand_wildcards' - $ref: '#/components/parameters/indices.put_mapping-ignore_unavailable' - $ref: '#/components/parameters/indices.put_mapping-master_timeout' - $ref: '#/components/parameters/indices.put_mapping-timeout' - $ref: '#/components/parameters/indices.put_mapping-write_index_only' requestBody: $ref: '#/components/requestBodies/indices.put_mapping' responses: '200': $ref: '#/components/responses/indices.put_mapping-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /_settings: get: tags: - indices summary: Get index settings description: 'Get setting information for one or more indices. For data streams, it returns setting information for the stream''s backing indices. ## Required authorization * Index privileges: `view_index_metadata` ' operationId: indices-get-settings parameters: - $ref: '#/components/parameters/indices.get_settings-allow_no_indices' - $ref: '#/components/parameters/indices.get_settings-expand_wildcards' - $ref: '#/components/parameters/indices.get_settings-flat_settings' - $ref: '#/components/parameters/indices.get_settings-ignore_unavailable' - $ref: '#/components/parameters/indices.get_settings-include_defaults' - $ref: '#/components/parameters/indices.get_settings-local' - $ref: '#/components/parameters/indices.get_settings-master_timeout' responses: '200': $ref: '#/components/responses/indices.get_settings-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name put: tags: - indices summary: Update index settings description: "Changes dynamic index settings in real time.\nFor data streams, index setting changes are applied to all backing indices by default.\n\nTo revert a setting to the default value, use a null value.\nThe list of per-index settings that can be updated dynamically on live indices can be found in index settings documentation.\nTo preserve existing settings from being updated, set the `preserve_existing` parameter to `true`.\n\nFor performance optimization during bulk indexing, you can disable the refresh interval.\nRefer to [disable refresh interval](https://www.elastic.co/docs/deploy-manage/production-guidance/optimize-performance/indexing-speed#disable-refresh-interval) for an example.\nThere are multiple valid ways to represent index settings in the request body. You can specify only the setting, for example:\n\n```\n{\n \"number_of_replicas\": 1\n}\n```\n\nOr you can use an `index` setting object:\n```\n{\n \"index\": {\n \"number_of_replicas\": 1\n }\n}\n```\n\nOr you can use dot annotation:\n```\n{\n \"index.number_of_replicas\": 1\n}\n```\n\nOr you can embed any of the aforementioned options in a `settings` object. For example:\n\n```\n{\n \"settings\": {\n \"index\": {\n \"number_of_replicas\": 1\n }\n }\n}\n```\n\nNOTE: You can only define new analyzers on closed indices.\nTo add an analyzer, you must close the index, define the analyzer, and reopen the index.\nYou cannot close the write index of a data stream.\nTo update the analyzer for a data stream's write index and future backing indices, update the analyzer in the index template used by the stream.\nThen roll over the data stream to apply the new analyzer to the stream's write index and future backing indices.\nThis affects searches and any new data added to the stream after the rollover.\nHowever, it does not affect the data stream's backing indices or their existing data.\nTo change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it.\nRefer to [updating analyzers on existing indices](https://www.elastic.co/docs/manage-data/data-store/text-analysis/specify-an-analyzer#update-analyzers-on-existing-indices) for step-by-step examples.\n\n## Required authorization\n\n* Index privileges: `manage`\n" externalDocs: description: More about index settings url: https://www.elastic.co/docs/reference/elasticsearch/index-settings/ x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-update-settings.html operationId: indices-put-settings parameters: - $ref: '#/components/parameters/indices.put_settings-allow_no_indices' - $ref: '#/components/parameters/indices.put_settings-expand_wildcards' - $ref: '#/components/parameters/indices.put_settings-flat_settings' - $ref: '#/components/parameters/indices.put_settings-ignore_unavailable' - $ref: '#/components/parameters/indices.put_settings-master_timeout' - $ref: '#/components/parameters/indices.put_settings-preserve_existing' - $ref: '#/components/parameters/indices.put_settings-reopen' - $ref: '#/components/parameters/indices.put_settings-timeout' requestBody: $ref: '#/components/requestBodies/indices.put_settings' responses: '200': $ref: '#/components/responses/indices.put_settings-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /{index}/_settings: get: tags: - indices summary: Get index settings description: 'Get setting information for one or more indices. For data streams, it returns setting information for the stream''s backing indices. ## Required authorization * Index privileges: `view_index_metadata` ' operationId: indices-get-settings-1 parameters: - $ref: '#/components/parameters/indices.get_settings-index' - $ref: '#/components/parameters/indices.get_settings-allow_no_indices' - $ref: '#/components/parameters/indices.get_settings-expand_wildcards' - $ref: '#/components/parameters/indices.get_settings-flat_settings' - $ref: '#/components/parameters/indices.get_settings-ignore_unavailable' - $ref: '#/components/parameters/indices.get_settings-include_defaults' - $ref: '#/components/parameters/indices.get_settings-local' - $ref: '#/components/parameters/indices.get_settings-master_timeout' responses: '200': $ref: '#/components/responses/indices.get_settings-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name put: tags: - indices summary: Update index settings description: "Changes dynamic index settings in real time.\nFor data streams, index setting changes are applied to all backing indices by default.\n\nTo revert a setting to the default value, use a null value.\nThe list of per-index settings that can be updated dynamically on live indices can be found in index settings documentation.\nTo preserve existing settings from being updated, set the `preserve_existing` parameter to `true`.\n\nFor performance optimization during bulk indexing, you can disable the refresh interval.\nRefer to [disable refresh interval](https://www.elastic.co/docs/deploy-manage/production-guidance/optimize-performance/indexing-speed#disable-refresh-interval) for an example.\nThere are multiple valid ways to represent index settings in the request body. You can specify only the setting, for example:\n\n```\n{\n \"number_of_replicas\": 1\n}\n```\n\nOr you can use an `index` setting object:\n```\n{\n \"index\": {\n \"number_of_replicas\": 1\n }\n}\n```\n\nOr you can use dot annotation:\n```\n{\n \"index.number_of_replicas\": 1\n}\n```\n\nOr you can embed any of the aforementioned options in a `settings` object. For example:\n\n```\n{\n \"settings\": {\n \"index\": {\n \"number_of_replicas\": 1\n }\n }\n}\n```\n\nNOTE: You can only define new analyzers on closed indices.\nTo add an analyzer, you must close the index, define the analyzer, and reopen the index.\nYou cannot close the write index of a data stream.\nTo update the analyzer for a data stream's write index and future backing indices, update the analyzer in the index template used by the stream.\nThen roll over the data stream to apply the new analyzer to the stream's write index and future backing indices.\nThis affects searches and any new data added to the stream after the rollover.\nHowever, it does not affect the data stream's backing indices or their existing data.\nTo change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it.\nRefer to [updating analyzers on existing indices](https://www.elastic.co/docs/manage-data/data-store/text-analysis/specify-an-analyzer#update-analyzers-on-existing-indices) for step-by-step examples.\n\n## Required authorization\n\n* Index privileges: `manage`\n" externalDocs: description: More about index settings url: https://www.elastic.co/docs/reference/elasticsearch/index-settings/ x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-update-settings.html operationId: indices-put-settings-1 parameters: - $ref: '#/components/parameters/indices.put_settings-index' - $ref: '#/components/parameters/indices.put_settings-allow_no_indices' - $ref: '#/components/parameters/indices.put_settings-expand_wildcards' - $ref: '#/components/parameters/indices.put_settings-flat_settings' - $ref: '#/components/parameters/indices.put_settings-ignore_unavailable' - $ref: '#/components/parameters/indices.put_settings-master_timeout' - $ref: '#/components/parameters/indices.put_settings-preserve_existing' - $ref: '#/components/parameters/indices.put_settings-reopen' - $ref: '#/components/parameters/indices.put_settings-timeout' requestBody: $ref: '#/components/requestBodies/indices.put_settings' responses: '200': $ref: '#/components/responses/indices.put_settings-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /{index}/_settings/{name}: get: tags: - indices summary: Get index settings description: 'Get setting information for one or more indices. For data streams, it returns setting information for the stream''s backing indices. ## Required authorization * Index privileges: `view_index_metadata` ' operationId: indices-get-settings-2 parameters: - $ref: '#/components/parameters/indices.get_settings-index' - $ref: '#/components/parameters/indices.get_settings-name' - $ref: '#/components/parameters/indices.get_settings-allow_no_indices' - $ref: '#/components/parameters/indices.get_settings-expand_wildcards' - $ref: '#/components/parameters/indices.get_settings-flat_settings' - $ref: '#/components/parameters/indices.get_settings-ignore_unavailable' - $ref: '#/components/parameters/indices.get_settings-include_defaults' - $ref: '#/components/parameters/indices.get_settings-local' - $ref: '#/components/parameters/indices.get_settings-master_timeout' responses: '200': $ref: '#/components/responses/indices.get_settings-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /_settings/{name}: get: tags: - indices summary: Get index settings description: 'Get setting information for one or more indices. For data streams, it returns setting information for the stream''s backing indices. ## Required authorization * Index privileges: `view_index_metadata` ' operationId: indices-get-settings-3 parameters: - $ref: '#/components/parameters/indices.get_settings-name' - $ref: '#/components/parameters/indices.get_settings-allow_no_indices' - $ref: '#/components/parameters/indices.get_settings-expand_wildcards' - $ref: '#/components/parameters/indices.get_settings-flat_settings' - $ref: '#/components/parameters/indices.get_settings-ignore_unavailable' - $ref: '#/components/parameters/indices.get_settings-include_defaults' - $ref: '#/components/parameters/indices.get_settings-local' - $ref: '#/components/parameters/indices.get_settings-master_timeout' responses: '200': $ref: '#/components/responses/indices.get_settings-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /_template: get: tags: - indices summary: Get legacy index templates description: 'Get information about one or more index templates. IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. ## Required authorization * Cluster privileges: `manage_index_templates` ' externalDocs: description: Learn more about templates url: https://www.elastic.co/docs/manage-data/data-store/templates x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-get-template-v1.html operationId: indices-get-template parameters: - $ref: '#/components/parameters/indices.get_template-flat_settings' - $ref: '#/components/parameters/indices.get_template-local' - $ref: '#/components/parameters/indices.get_template-master_timeout' responses: '200': $ref: '#/components/responses/indices.get_template-200' deprecated: true x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /{index}/_open: post: tags: - indices summary: Open a closed index description: 'For data streams, the API opens any closed backing indices. A closed index is blocked for read/write operations and does not allow all operations that opened indices allow. It is not possible to index documents or to search for documents in a closed index. This allows closed indices to not have to maintain internal data structures for indexing or searching documents, resulting in a smaller overhead on the cluster. When opening or closing an index, the master is responsible for restarting the index shards to reflect the new state of the index. The shards will then go through the normal recovery process. The 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. You can open and close multiple indices. An error is thrown if the request explicitly refers to a missing index. This behavior can be turned off by using the `ignore_unavailable=true` parameter. By default, you must explicitly name the indices you are opening or closing. To open or close indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`. This setting can also be changed with the cluster update settings API. Closed indices consume a significant amount of disk-space which can cause problems in managed environments. Closing indices can be turned off with the cluster settings API by setting `cluster.indices.close.enable` to `false`. Because 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. ## Required authorization * Index privileges: `manage` ' operationId: indices-open parameters: - in: path name: index description: 'Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). By default, you must explicitly name the indices you using to limit the request. To limit a request using `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to false. You can update this setting in the `elasticsearch.yml` file or using the cluster update settings API.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple - in: query name: allow_no_indices description: 'A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.' deprecated: false schema: default: true type: boolean style: form - in: query name: expand_wildcards description: 'Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.' deprecated: false schema: default: closed allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form - in: query name: ignore_unavailable description: 'If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.' deprecated: false schema: default: false type: boolean style: form - in: query name: master_timeout 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.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form - in: query name: timeout description: 'Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form - in: query name: wait_for_active_shards description: 'The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).' deprecated: false schema: default: '1' allOf: - $ref: '#/components/schemas/_types.WaitForActiveShards' style: form responses: '200': description: '' content: application/json: schema: type: object properties: acknowledged: type: boolean shards_acknowledged: type: boolean required: - acknowledged - shards_acknowledged examples: indicesOpenResponseExample1: description: A successful response for opening an index. value: "{\n \"acknowledged\" : true,\n \"shards_acknowledged\" : true\n}" x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /_recovery: get: tags: - indices summary: Get index recovery information description: 'Get information about ongoing and completed shard recoveries for one or more indices. For data streams, the API returns information for the stream''s backing indices. All recoveries, whether ongoing or complete, are kept in the cluster state and may be reported on at any time. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. Recovery automatically occurs during the following processes: * When creating an index for the first time. * When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. * Creation of new replica shard copies from the primary. * Relocation of a shard copy to a different node in the same cluster. * A snapshot restore operation. * A clone, shrink, or split operation. You can determine the cause of a shard recovery using the recovery or cat recovery APIs. The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. ## Required authorization * Index privileges: `monitor` ' operationId: indices-recovery parameters: - $ref: '#/components/parameters/indices.recovery-active_only' - $ref: '#/components/parameters/indices.recovery-detailed' - $ref: '#/components/parameters/indices.recovery-allow_no_indices' - $ref: '#/components/parameters/indices.recovery-expand_wildcards' - $ref: '#/components/parameters/indices.recovery-ignore_unavailable' responses: '200': $ref: '#/components/responses/indices.recovery-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /{index}/_recovery: get: tags: - indices summary: Get index recovery information description: 'Get information about ongoing and completed shard recoveries for one or more indices. For data streams, the API returns information for the stream''s backing indices. All recoveries, whether ongoing or complete, are kept in the cluster state and may be reported on at any time. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. Recovery automatically occurs during the following processes: * When creating an index for the first time. * When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. * Creation of new replica shard copies from the primary. * Relocation of a shard copy to a different node in the same cluster. * A snapshot restore operation. * A clone, shrink, or split operation. You can determine the cause of a shard recovery using the recovery or cat recovery APIs. The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. ## Required authorization * Index privileges: `monitor` ' operationId: indices-recovery-1 parameters: - $ref: '#/components/parameters/indices.recovery-index' - $ref: '#/components/parameters/indices.recovery-active_only' - $ref: '#/components/parameters/indices.recovery-detailed' - $ref: '#/components/parameters/indices.recovery-allow_no_indices' - $ref: '#/components/parameters/indices.recovery-expand_wildcards' - $ref: '#/components/parameters/indices.recovery-ignore_unavailable' responses: '200': $ref: '#/components/responses/indices.recovery-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /_refresh: get: tags: - indices summary: Refresh an index description: 'A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s backing indices. By default, Elasticsearch periodically refreshes indices every second, but only on indices that have received one search request or more in the last 30 seconds. You can change this default interval with the `index.refresh_interval` setting. In Elastic Cloud Serverless, the default refresh interval is 5 seconds across all indices. Refresh requests are synchronous and do not return a response until the refresh operation completes. Refreshes are resource-intensive. To ensure good cluster performance, it''s recommended to wait for Elasticsearch''s periodic refresh rather than performing an explicit refresh when possible. If your application workflow indexes documents and then runs a search to retrieve the indexed document, it''s recommended to use the index API''s `refresh=wait_for` query parameter option. This option ensures the indexing operation waits for a periodic refresh before running the search. ## Required authorization * Index privileges: `maintenance` ' externalDocs: description: More about the refresh parameter url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/refresh-parameter x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-refresh.html operationId: indices-refresh-1 parameters: - $ref: '#/components/parameters/indices.refresh-allow_no_indices' - $ref: '#/components/parameters/indices.refresh-expand_wildcards' - $ref: '#/components/parameters/indices.refresh-ignore_unavailable' responses: '200': $ref: '#/components/responses/indices.refresh-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name post: tags: - indices summary: Refresh an index description: 'A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s backing indices. By default, Elasticsearch periodically refreshes indices every second, but only on indices that have received one search request or more in the last 30 seconds. You can change this default interval with the `index.refresh_interval` setting. In Elastic Cloud Serverless, the default refresh interval is 5 seconds across all indices. Refresh requests are synchronous and do not return a response until the refresh operation completes. Refreshes are resource-intensive. To ensure good cluster performance, it''s recommended to wait for Elasticsearch''s periodic refresh rather than performing an explicit refresh when possible. If your application workflow indexes documents and then runs a search to retrieve the indexed document, it''s recommended to use the index API''s `refresh=wait_for` query parameter option. This option ensures the indexing operation waits for a periodic refresh before running the search. ## Required authorization * Index privileges: `maintenance` ' externalDocs: description: More about the refresh parameter url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/refresh-parameter x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-refresh.html operationId: indices-refresh parameters: - $ref: '#/components/parameters/indices.refresh-allow_no_indices' - $ref: '#/components/parameters/indices.refresh-expand_wildcards' - $ref: '#/components/parameters/indices.refresh-ignore_unavailable' responses: '200': $ref: '#/components/responses/indices.refresh-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /{index}/_refresh: get: tags: - indices summary: Refresh an index description: 'A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s backing indices. By default, Elasticsearch periodically refreshes indices every second, but only on indices that have received one search request or more in the last 30 seconds. You can change this default interval with the `index.refresh_interval` setting. In Elastic Cloud Serverless, the default refresh interval is 5 seconds across all indices. Refresh requests are synchronous and do not return a response until the refresh operation completes. Refreshes are resource-intensive. To ensure good cluster performance, it''s recommended to wait for Elasticsearch''s periodic refresh rather than performing an explicit refresh when possible. If your application workflow indexes documents and then runs a search to retrieve the indexed document, it''s recommended to use the index API''s `refresh=wait_for` query parameter option. This option ensures the indexing operation waits for a periodic refresh before running the search. ## Required authorization * Index privileges: `maintenance` ' externalDocs: description: More about the refresh parameter url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/refresh-parameter x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-refresh.html operationId: indices-refresh-3 parameters: - $ref: '#/components/parameters/indices.refresh-index' - $ref: '#/components/parameters/indices.refresh-allow_no_indices' - $ref: '#/components/parameters/indices.refresh-expand_wildcards' - $ref: '#/components/parameters/indices.refresh-ignore_unavailable' responses: '200': $ref: '#/components/responses/indices.refresh-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name post: tags: - indices summary: Refresh an index description: 'A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s backing indices. By default, Elasticsearch periodically refreshes indices every second, but only on indices that have received one search request or more in the last 30 seconds. You can change this default interval with the `index.refresh_interval` setting. In Elastic Cloud Serverless, the default refresh interval is 5 seconds across all indices. Refresh requests are synchronous and do not return a response until the refresh operation completes. Refreshes are resource-intensive. To ensure good cluster performance, it''s recommended to wait for Elasticsearch''s periodic refresh rather than performing an explicit refresh when possible. If your application workflow indexes documents and then runs a search to retrieve the indexed document, it''s recommended to use the index API''s `refresh=wait_for` query parameter option. This option ensures the indexing operation waits for a periodic refresh before running the search. ## Required authorization * Index privileges: `maintenance` ' externalDocs: description: More about the refresh parameter url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/refresh-parameter x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-refresh.html operationId: indices-refresh-2 parameters: - $ref: '#/components/parameters/indices.refresh-index' - $ref: '#/components/parameters/indices.refresh-allow_no_indices' - $ref: '#/components/parameters/indices.refresh-expand_wildcards' - $ref: '#/components/parameters/indices.refresh-ignore_unavailable' responses: '200': $ref: '#/components/responses/indices.refresh-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /{index}/_reload_search_analyzers: get: tags: - indices summary: Reload search analyzers description: 'Reload an index''s search analyzers and their resources. For data streams, the API reloads search analyzers and resources for the stream''s backing indices. IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn''t contain responses derived from the previous versions of the analyzer. You can use the reload search analyzers API to pick up changes to synonym files used in the `synonym_graph` or `synonym` token filter of a search analyzer. To be eligible, the token filter must have an `updateable` flag of `true` and only be used in search analyzers. NOTE: This API does not perform a reload for each shard of an index. Instead, it performs a reload for each node containing index shards. As a result, the total shard count returned by the API can differ from the number of index shards. Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don''t contain a shard replica--before using this API. This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future. ## Required authorization * Index privileges: `manage` ' externalDocs: description: More about the search_analyzer url: https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/search-analyzer x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-reload-analyzers.html operationId: indices-reload-search-analyzers parameters: - $ref: '#/components/parameters/indices.reload_search_analyzers-index' - $ref: '#/components/parameters/indices.reload_search_analyzers-allow_no_indices' - $ref: '#/components/parameters/indices.reload_search_analyzers-expand_wildcards' - $ref: '#/components/parameters/indices.reload_search_analyzers-ignore_unavailable' - $ref: '#/components/parameters/indices.reload_search_analyzers-resource' responses: '200': $ref: '#/components/responses/indices.reload_search_analyzers-200' x-state: Generally available; Added in 7.3.0 x-metaTags: - content: Elasticsearch name: product_name post: tags: - indices summary: Reload search analyzers description: 'Reload an index''s search analyzers and their resources. For data streams, the API reloads search analyzers and resources for the stream''s backing indices. IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn''t contain responses derived from the previous versions of the analyzer. You can use the reload search analyzers API to pick up changes to synonym files used in the `synonym_graph` or `synonym` token filter of a search analyzer. To be eligible, the token filter must have an `updateable` flag of `true` and only be used in search analyzers. NOTE: This API does not perform a reload for each shard of an index. Instead, it performs a reload for each node containing index shards. As a result, the total shard count returned by the API can differ from the number of index shards. Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don''t contain a shard replica--before using this API. This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future. ## Required authorization * Index privileges: `manage` ' externalDocs: description: More about the search_analyzer url: https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/search-analyzer x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/indices-reload-analyzers.html operationId: indices-reload-search-analyzers-1 parameters: - $ref: '#/components/parameters/indices.reload_search_analyzers-index' - $ref: '#/components/parameters/indices.reload_search_analyzers-allow_no_indices' - $ref: '#/components/parameters/indices.reload_search_analyzers-expand_wildcards' - $ref: '#/components/parameters/indices.reload_search_analyzers-ignore_unavailable' - $ref: '#/components/parameters/indices.reload_search_analyzers-resource' responses: '200': $ref: '#/components/responses/indices.reload_search_analyzers-200' x-state: Generally available; Added in 7.3.0 x-metaTags: - content: Elasticsearch name: product_name /_resolve/cluster: get: tags: - indices summary: Resolve the cluster description: 'Resolve the specified index expressions to return information about each cluster, including the local "querying" cluster, if included. If no index expression is provided, the API will return information about all the remote clusters that are configured on the querying cluster. This endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search. You use the same index expression with this endpoint as you would for cross-cluster search. Index and cluster exclusions are also supported with this endpoint. For each cluster in the index expression, information is returned about: * Whether the querying ("local") cluster is currently connected to each remote cluster specified in the index expression. Note that this endpoint actively attempts to contact the remote clusters, unlike the `remote/info` endpoint. * Whether each remote cluster is configured with `skip_unavailable` as `true` or `false`. * Whether there are any indices, aliases, or data streams on that cluster that match the index expression. * Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index). * Cluster version information, including the Elasticsearch server version. For example, `GET /_resolve/cluster/my-index-*,cluster*:my-index-*` returns information about the local cluster and all remotely configured clusters that start with the alias `cluster*`. Each cluster returns information about whether it has any indices, aliases or data streams that match `my-index-*`. ## Note on backwards compatibility The ability to query without an index expression was added in version 8.18, so when querying remote clusters older than that, the local cluster will send the index expression `dummy*` to those remote clusters. Thus, if an errors occur, you may see a reference to that index expression even though you didn''t request it. If it causes a problem, you can instead include an index expression like `*:*` to bypass the issue. ## Advantages of using this endpoint before a cross-cluster search You may want to exclude a cluster or index from a search when: * A remote cluster is not currently connected and is configured with `skip_unavailable=false`. Running a cross-cluster search under those conditions will cause the entire search to fail. * A cluster has no matching indices, aliases or data streams for the index expression (or your user does not have permissions to search them). For example, suppose your index expression is `logs*,remote1:logs*` and the remote1 cluster has no indices, aliases or data streams that match `logs*`. In that case, that cluster will return no results from that cluster if you include it in a cross-cluster search. * The index expression (combined with any query parameters you specify) will likely cause an exception to be thrown when you do the search. In these cases, the "error" field in the `_resolve/cluster` response will be present. (This is also where security/permission errors will be shown.) * A remote cluster is an older version that does not support the feature you want to use in your search. ## Test availability of remote clusters The `remote/info` endpoint is commonly used to test whether the "local" cluster (the cluster being queried) is connected to its remote clusters, but it does not necessarily reflect whether the remote cluster is available or not. The remote cluster may be available, while the local cluster is not currently connected to it. You can use the `_resolve/cluster` API to attempt to reconnect to remote clusters. For example with `GET _resolve/cluster` or `GET _resolve/cluster/*:*`. The `connected` field in the response will indicate whether it was successful. If a connection was (re-)established, this will also cause the `remote/info` endpoint to now indicate a connected status. ## Required authorization * Index privileges: `view_index_metadata` ' operationId: indices-resolve-cluster parameters: - $ref: '#/components/parameters/indices.resolve_cluster-allow_no_indices' - $ref: '#/components/parameters/indices.resolve_cluster-expand_wildcards' - $ref: '#/components/parameters/indices.resolve_cluster-ignore_throttled' - $ref: '#/components/parameters/indices.resolve_cluster-ignore_unavailable' - $ref: '#/components/parameters/indices.resolve_cluster-timeout' responses: '200': $ref: '#/components/responses/indices.resolve_cluster-200' x-state: Generally available; Added in 8.13.0 x-metaTags: - content: Elasticsearch name: product_name /_resolve/cluster/{name}: get: tags: - indices summary: Resolve the cluster description: 'Resolve the specified index expressions to return information about each cluster, including the local "querying" cluster, if included. If no index expression is provided, the API will return information about all the remote clusters that are configured on the querying cluster. This endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search. You use the same index expression with this endpoint as you would for cross-cluster search. Index and cluster exclusions are also supported with this endpoint. For each cluster in the index expression, information is returned about: * Whether the querying ("local") cluster is currently connected to each remote cluster specified in the index expression. Note that this endpoint actively attempts to contact the remote clusters, unlike the `remote/info` endpoint. * Whether each remote cluster is configured with `skip_unavailable` as `true` or `false`. * Whether there are any indices, aliases, or data streams on that cluster that match the index expression. * Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index). * Cluster version information, including the Elasticsearch server version. For example, `GET /_resolve/cluster/my-index-*,cluster*:my-index-*` returns information about the local cluster and all remotely configured clusters that start with the alias `cluster*`. Each cluster returns information about whether it has any indices, aliases or data streams that match `my-index-*`. ## Note on backwards compatibility The ability to query without an index expression was added in version 8.18, so when querying remote clusters older than that, the local cluster will send the index expression `dummy*` to those remote clusters. Thus, if an errors occur, you may see a reference to that index expression even though you didn''t request it. If it causes a problem, you can instead include an index expression like `*:*` to bypass the issue. ## Advantages of using this endpoint before a cross-cluster search You may want to exclude a cluster or index from a search when: * A remote cluster is not currently connected and is configured with `skip_unavailable=false`. Running a cross-cluster search under those conditions will cause the entire search to fail. * A cluster has no matching indices, aliases or data streams for the index expression (or your user does not have permissions to search them). For example, suppose your index expression is `logs*,remote1:logs*` and the remote1 cluster has no indices, aliases or data streams that match `logs*`. In that case, that cluster will return no results from that cluster if you include it in a cross-cluster search. * The index expression (combined with any query parameters you specify) will likely cause an exception to be thrown when you do the search. In these cases, the "error" field in the `_resolve/cluster` response will be present. (This is also where security/permission errors will be shown.) * A remote cluster is an older version that does not support the feature you want to use in your search. ## Test availability of remote clusters The `remote/info` endpoint is commonly used to test whether the "local" cluster (the cluster being queried) is connected to its remote clusters, but it does not necessarily reflect whether the remote cluster is available or not. The remote cluster may be available, while the local cluster is not currently connected to it. You can use the `_resolve/cluster` API to attempt to reconnect to remote clusters. For example with `GET _resolve/cluster` or `GET _resolve/cluster/*:*`. The `connected` field in the response will indicate whether it was successful. If a connection was (re-)established, this will also cause the `remote/info` endpoint to now indicate a connected status. ## Required authorization * Index privileges: `view_index_metadata` ' operationId: indices-resolve-cluster-1 parameters: - $ref: '#/components/parameters/indices.resolve_cluster-name' - $ref: '#/components/parameters/indices.resolve_cluster-allow_no_indices' - $ref: '#/components/parameters/indices.resolve_cluster-expand_wildcards' - $ref: '#/components/parameters/indices.resolve_cluster-ignore_throttled' - $ref: '#/components/parameters/indices.resolve_cluster-ignore_unavailable' - $ref: '#/components/parameters/indices.resolve_cluster-timeout' responses: '200': $ref: '#/components/responses/indices.resolve_cluster-200' x-state: Generally available; Added in 8.13.0 x-metaTags: - content: Elasticsearch name: product_name /_resolve/index/{name}: get: tags: - indices summary: Resolve indices description: 'Resolve the names and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported. ## Required authorization * Index privileges: `view_index_metadata` ' operationId: indices-resolve-index parameters: - $ref: '#/components/parameters/indices.resolve_index-name' - $ref: '#/components/parameters/indices.resolve_index-expand_wildcards' - $ref: '#/components/parameters/indices.resolve_index-ignore_unavailable' - $ref: '#/components/parameters/indices.resolve_index-allow_no_indices' - $ref: '#/components/parameters/indices.resolve_index-mode' requestBody: $ref: '#/components/requestBodies/indices.resolve_index' responses: '200': $ref: '#/components/responses/indices.resolve_index-200' x-state: Generally available; Added in 7.9.0 x-metaTags: - content: Elasticsearch name: product_name post: tags: - indices summary: Resolve indices description: 'Resolve the names and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported. ## Required authorization * Index privileges: `view_index_metadata` ' operationId: indices-resolve-index-1 parameters: - $ref: '#/components/parameters/indices.resolve_index-name' - $ref: '#/components/parameters/indices.resolve_index-expand_wildcards' - $ref: '#/components/parameters/indices.resolve_index-ignore_unavailable' - $ref: '#/components/parameters/indices.resolve_index-allow_no_indices' - $ref: '#/components/parameters/indices.resolve_index-mode' requestBody: $ref: '#/components/requestBodies/indices.resolve_index' responses: '200': $ref: '#/components/responses/indices.resolve_index-200' x-state: Generally available; Added in 7.9.0 x-metaTags: - content: Elasticsearch name: product_name /{alias}/_rollover: post: tags: - indices summary: Roll over to a new index description: 'TIP: We recommend using the index lifecycle rollover action to automate rollovers. However, Serverless does not support Index Lifecycle Management (ILM), so don''t use this approach in the Serverless context. The rollover API creates a new index for a data stream or index alias. The API behavior depends on the rollover target. **Roll over a data stream** If you roll over a data stream, the API creates a new write index for the stream. The stream''s previous write index becomes a regular backing index. A rollover also increments the data stream''s generation. **Roll over an index alias with a write index** TIP: Prior to Elasticsearch 7.9, you''d typically use an index alias with a write index to manage time series data. Data streams replace this functionality, require less maintenance, and automatically integrate with data tiers. If an index alias points to multiple indices, one of the indices must be a write index. The rollover API creates a new write index for the alias with `is_write_index` set to `true`. The API also `sets is_write_index` to `false` for the previous write index. **Roll over an index alias with one index** If you roll over an index alias that points to only one index, the API creates a new index for the alias and removes the original index from the alias. NOTE: A rollover creates a new index and is subject to the `wait_for_active_shards` setting. **Increment index names for an alias** When you roll over an index alias, you can specify a name for the new index. If you don''t specify a name and the current index ends with `-` and a number, such as `my-index-000001` or `my-index-3`, the new index name increments that number. For example, if you roll over an alias with a current index of `my-index-000001`, the rollover creates a new index named `my-index-000002`. This number is always six characters and zero-padded, regardless of the previous index''s name. If you use an index alias for time series data, you can use date math in the index name to track the rollover date. For example, you can create an alias that points to an index named ``. If you create the index on May 6, 2099, the index''s name is `my-index-2099.05.06-000001`. If you roll over the alias on May 7, 2099, the new index''s name is `my-index-2099.05.07-000002`. ## Required authorization * Index privileges: `manage` ' operationId: indices-rollover parameters: - $ref: '#/components/parameters/indices.rollover-alias' - $ref: '#/components/parameters/indices.rollover-dry_run' - $ref: '#/components/parameters/indices.rollover-master_timeout' - $ref: '#/components/parameters/indices.rollover-timeout' - $ref: '#/components/parameters/indices.rollover-wait_for_active_shards' - $ref: '#/components/parameters/indices.rollover-lazy' requestBody: $ref: '#/components/requestBodies/indices.rollover' responses: '200': $ref: '#/components/responses/indices.rollover-200' x-state: Generally available; Added in 5.0.0 x-metaTags: - content: Elasticsearch name: product_name /{alias}/_rollover/{new_index}: post: tags: - indices summary: Roll over to a new index description: 'TIP: We recommend using the index lifecycle rollover action to automate rollovers. However, Serverless does not support Index Lifecycle Management (ILM), so don''t use this approach in the Serverless context. The rollover API creates a new index for a data stream or index alias. The API behavior depends on the rollover target. **Roll over a data stream** If you roll over a data stream, the API creates a new write index for the stream. The stream''s previous write index becomes a regular backing index. A rollover also increments the data stream''s generation. **Roll over an index alias with a write index** TIP: Prior to Elasticsearch 7.9, you''d typically use an index alias with a write index to manage time series data. Data streams replace this functionality, require less maintenance, and automatically integrate with data tiers. If an index alias points to multiple indices, one of the indices must be a write index. The rollover API creates a new write index for the alias with `is_write_index` set to `true`. The API also `sets is_write_index` to `false` for the previous write index. **Roll over an index alias with one index** If you roll over an index alias that points to only one index, the API creates a new index for the alias and removes the original index from the alias. NOTE: A rollover creates a new index and is subject to the `wait_for_active_shards` setting. **Increment index names for an alias** When you roll over an index alias, you can specify a name for the new index. If you don''t specify a name and the current index ends with `-` and a number, such as `my-index-000001` or `my-index-3`, the new index name increments that number. For example, if you roll over an alias with a current index of `my-index-000001`, the rollover creates a new index named `my-index-000002`. This number is always six characters and zero-padded, regardless of the previous index''s name. If you use an index alias for time series data, you can use date math in the index name to track the rollover date. For example, you can create an alias that points to an index named ``. If you create the index on May 6, 2099, the index''s name is `my-index-2099.05.06-000001`. If you roll over the alias on May 7, 2099, the new index''s name is `my-index-2099.05.07-000002`. ## Required authorization * Index privileges: `manage` ' operationId: indices-rollover-1 parameters: - $ref: '#/components/parameters/indices.rollover-alias' - $ref: '#/components/parameters/indices.rollover-new_index' - $ref: '#/components/parameters/indices.rollover-dry_run' - $ref: '#/components/parameters/indices.rollover-master_timeout' - $ref: '#/components/parameters/indices.rollover-timeout' - $ref: '#/components/parameters/indices.rollover-wait_for_active_shards' - $ref: '#/components/parameters/indices.rollover-lazy' requestBody: $ref: '#/components/requestBodies/indices.rollover' responses: '200': $ref: '#/components/responses/indices.rollover-200' x-state: Generally available; Added in 5.0.0 x-metaTags: - content: Elasticsearch name: product_name /_segments: get: tags: - indices summary: Get index segments description: 'Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the stream''s backing indices. ## Required authorization * Index privileges: `monitor` ' operationId: indices-segments parameters: - $ref: '#/components/parameters/indices.segments-allow_no_indices' - $ref: '#/components/parameters/indices.segments-expand_wildcards' - $ref: '#/components/parameters/indices.segments-ignore_unavailable' responses: '200': $ref: '#/components/responses/indices.segments-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /{index}/_segments: get: tags: - indices summary: Get index segments description: 'Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the stream''s backing indices. ## Required authorization * Index privileges: `monitor` ' operationId: indices-segments-1 parameters: - $ref: '#/components/parameters/indices.segments-index' - $ref: '#/components/parameters/indices.segments-allow_no_indices' - $ref: '#/components/parameters/indices.segments-expand_wildcards' - $ref: '#/components/parameters/indices.segments-ignore_unavailable' responses: '200': $ref: '#/components/responses/indices.segments-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /_shard_stores: get: tags: - indices summary: Get index shard stores description: 'Get store information about replica shards in one or more indices. For data streams, the API retrieves store information for the stream''s backing indices. The index shard stores API returns the following information: * The node on which each replica shard exists. * The allocation ID for each replica shard. * A unique ID for each replica shard. * Any errors encountered while opening the shard index or from an earlier failure. By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. ## Required authorization * Index privileges: `monitor` ' operationId: indices-shard-stores parameters: - $ref: '#/components/parameters/indices.shard_stores-allow_no_indices' - $ref: '#/components/parameters/indices.shard_stores-expand_wildcards' - $ref: '#/components/parameters/indices.shard_stores-ignore_unavailable' - $ref: '#/components/parameters/indices.shard_stores-status' responses: '200': $ref: '#/components/responses/indices.shard_stores-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /{index}/_shard_stores: get: tags: - indices summary: Get index shard stores description: 'Get store information about replica shards in one or more indices. For data streams, the API retrieves store information for the stream''s backing indices. The index shard stores API returns the following information: * The node on which each replica shard exists. * The allocation ID for each replica shard. * A unique ID for each replica shard. * Any errors encountered while opening the shard index or from an earlier failure. By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. ## Required authorization * Index privileges: `monitor` ' operationId: indices-shard-stores-1 parameters: - $ref: '#/components/parameters/indices.shard_stores-index' - $ref: '#/components/parameters/indices.shard_stores-allow_no_indices' - $ref: '#/components/parameters/indices.shard_stores-expand_wildcards' - $ref: '#/components/parameters/indices.shard_stores-ignore_unavailable' - $ref: '#/components/parameters/indices.shard_stores-status' responses: '200': $ref: '#/components/responses/indices.shard_stores-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /{index}/_shrink/{target}: put: tags: - indices summary: Shrink an index description: "Shrink an index into a new index with fewer primary shards.\n\nBefore you can shrink an index:\n\n* The index must be read-only.\n* A copy of every shard in the index must reside on the same node.\n* The index must have a green health status.\n\nTo make shard allocation easier, we recommend you also remove the index's replica shards.\nYou can later re-add replica shards as part of the shrink operation.\n\nThe requested number of primary shards in the target index must be a factor of the number of shards in the source index.\nFor example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1.\nIf the number of shards in the index is a prime number it can only be shrunk into a single primary shard\n Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node.\n\nIMPORTANT: If the source index already has one primary shard, configuring the shrink operation with 'index.number_of_shards: 1' will cause the request to fail. An index with one primary shard cannot be shrunk further.\n\nThe current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk.\n\nA shrink operation:\n\n* Creates a new target index with the same definition as the source index, but with a smaller number of primary shards.\n* Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks.\n* Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the `.routing.allocation.initial_recovery._id` index setting.\n\nIMPORTANT: Indices can only be shrunk if they satisfy the following requirements:\n\n* The target index must not exist.\n* The source index must have more primary shards than the target index.\n* The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index.\n* The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard.\n* The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index.\n\n## Required authorization\n\n* Index privileges: `manage`\n" operationId: indices-shrink parameters: - $ref: '#/components/parameters/indices.shrink-index' - $ref: '#/components/parameters/indices.shrink-target' - $ref: '#/components/parameters/indices.shrink-master_timeout' - $ref: '#/components/parameters/indices.shrink-timeout' - $ref: '#/components/parameters/indices.shrink-wait_for_active_shards' requestBody: $ref: '#/components/requestBodies/indices.shrink' responses: '200': $ref: '#/components/responses/indices.shrink-200' x-state: Generally available; Added in 5.0.0 x-metaTags: - content: Elasticsearch name: product_name post: tags: - indices summary: Shrink an index description: "Shrink an index into a new index with fewer primary shards.\n\nBefore you can shrink an index:\n\n* The index must be read-only.\n* A copy of every shard in the index must reside on the same node.\n* The index must have a green health status.\n\nTo make shard allocation easier, we recommend you also remove the index's replica shards.\nYou can later re-add replica shards as part of the shrink operation.\n\nThe requested number of primary shards in the target index must be a factor of the number of shards in the source index.\nFor example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1.\nIf the number of shards in the index is a prime number it can only be shrunk into a single primary shard\n Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node.\n\nIMPORTANT: If the source index already has one primary shard, configuring the shrink operation with 'index.number_of_shards: 1' will cause the request to fail. An index with one primary shard cannot be shrunk further.\n\nThe current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk.\n\nA shrink operation:\n\n* Creates a new target index with the same definition as the source index, but with a smaller number of primary shards.\n* Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks.\n* Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the `.routing.allocation.initial_recovery._id` index setting.\n\nIMPORTANT: Indices can only be shrunk if they satisfy the following requirements:\n\n* The target index must not exist.\n* The source index must have more primary shards than the target index.\n* The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index.\n* The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard.\n* The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index.\n\n## Required authorization\n\n* Index privileges: `manage`\n" operationId: indices-shrink-1 parameters: - $ref: '#/components/parameters/indices.shrink-index' - $ref: '#/components/parameters/indices.shrink-target' - $ref: '#/components/parameters/indices.shrink-master_timeout' - $ref: '#/components/parameters/indices.shrink-timeout' - $ref: '#/components/parameters/indices.shrink-wait_for_active_shards' requestBody: $ref: '#/components/requestBodies/indices.shrink' responses: '200': $ref: '#/components/responses/indices.shrink-200' x-state: Generally available; Added in 5.0.0 x-metaTags: - content: Elasticsearch name: product_name /_index_template/_simulate_index/{name}: post: tags: - indices summary: Simulate an index description: 'Get the index configuration that would be applied to the specified index from an existing index template. ## Required authorization * Cluster privileges: `manage_index_templates` ' operationId: indices-simulate-index-template parameters: - in: path name: name description: Name of the index to simulate required: true deprecated: false schema: $ref: '#/components/schemas/_types.Name' style: simple - in: query name: create description: Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one deprecated: false schema: default: false type: boolean style: form - in: query name: cause description: User defined reason for dry-run creating the new template for simulation purposes deprecated: false schema: default: 'false' type: string style: form - in: query name: master_timeout 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. deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form - in: query name: include_defaults description: If true, returns all relevant default configurations for the index template. deprecated: false schema: default: false type: boolean x-state: Generally available; Added in 8.11.0 style: form requestBody: content: application/json: schema: $ref: '#/components/schemas/indices._types.IndexTemplate' responses: '200': description: '' content: application/json: schema: type: object properties: overlapping: type: array items: $ref: '#/components/schemas/indices.simulate_template.Overlapping' template: allOf: - $ref: '#/components/schemas/indices.simulate_template.Template' required: - template examples: indicesSimulateIndexTemplateResponseExample1: description: A successful response from `POST /_index_template/_simulate_index/my-index-000001`. value: "{\n \"template\" : {\n \"settings\" : {\n \"index\" : {\n \"number_of_shards\" : \"2\",\n \"number_of_replicas\" : \"0\",\n \"routing\" : {\n \"allocation\" : {\n \"include\" : {\n \"_tier_preference\" : \"data_content\"\n }\n }\n }\n }\n },\n \"mappings\" : {\n \"properties\" : {\n \"@timestamp\" : {\n \"type\" : \"date\"\n }\n }\n },\n \"aliases\" : { }\n },\n \"overlapping\" : [\n {\n \"name\" : \"template_1\",\n \"index_patterns\" : [\n \"my-index-*\"\n ]\n }\n ]\n}" x-state: Generally available; Added in 7.9.0 x-metaTags: - content: Elasticsearch name: product_name /_index_template/_simulate: post: tags: - indices summary: Simulate an index template description: 'Get the index configuration that would be applied by a particular index template. ## Required authorization * Cluster privileges: `manage_index_templates` ' operationId: indices-simulate-template parameters: - $ref: '#/components/parameters/indices.simulate_template-create' - $ref: '#/components/parameters/indices.simulate_template-cause' - $ref: '#/components/parameters/indices.simulate_template-master_timeout' - $ref: '#/components/parameters/indices.simulate_template-include_defaults' requestBody: $ref: '#/components/requestBodies/indices.simulate_template' responses: '200': $ref: '#/components/responses/indices.simulate_template-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /_index_template/_simulate/{name}: post: tags: - indices summary: Simulate an index template description: 'Get the index configuration that would be applied by a particular index template. ## Required authorization * Cluster privileges: `manage_index_templates` ' operationId: indices-simulate-template-1 parameters: - $ref: '#/components/parameters/indices.simulate_template-name' - $ref: '#/components/parameters/indices.simulate_template-create' - $ref: '#/components/parameters/indices.simulate_template-cause' - $ref: '#/components/parameters/indices.simulate_template-master_timeout' - $ref: '#/components/parameters/indices.simulate_template-include_defaults' requestBody: $ref: '#/components/requestBodies/indices.simulate_template' responses: '200': $ref: '#/components/responses/indices.simulate_template-200' x-state: Generally available x-metaTags: - content: Elasticsearch name: product_name /{index}/_split/{target}: put: tags: - indices summary: Split an index description: 'Split an index into a new index with more primary shards. * Before you can split an index: * The index must be read-only. * The cluster health status must be green. You can do make an index read-only with the following request using the add index block API: ``` PUT /my_source_index/_block/write ``` The current write index on a data stream cannot be split. In order to split the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be split. The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the `index.number_of_routing_shards` setting. The number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing. For instance, a 5 shard index with `number_of_routing_shards` set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3. A split operation: * Creates a new target index with the same definition as the source index, but with a larger number of primary shards. * Hard-links segments from the source index into the target index. If the file system doesn''t support hard-linking, all segments are copied into the new index, which is a much more time consuming process. * Hashes all documents again, after low level files are created, to delete documents that belong to a different shard. * Recovers the target index as though it were a closed index which had just been re-opened. IMPORTANT: Indices can only be split if they satisfy the following requirements: * The target index must not exist. * The source index must have fewer primary shards than the target index. * The number of primary shards in the target index must be a multiple of the number of primary shards in the source index. * The number of primary shards in the target index must be a divisor of the source index''s `index.number_of_routing_shards`. * The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index. ## Required authorization * Index privileges: `manage` ' operationId: indices-split parameters: - $ref: '#/components/parameters/indices.split-index' - $ref: '#/components/parameters/indices.split-target' - $ref: '#/components/parameters/indices.split-master_timeout' - $ref: '#/components/parameters/indices.split-timeout' - $ref: '#/components/parameters/indices.split-wait_for_active_shards' requestBody: $ref: '#/components/requestBodies/indices.split' responses: '200': $ref: '#/components/responses/indices.split-200' x-state: Generally available; Added in 6.1.0 x-metaTags: - content: Elasticsearch name: product_name post: tags: - indices summary: Split an index description: 'Split an index into a new index with more primary shards. * Before you can split an index: * The index must be read-only. * The cluster health status must be green. You can do make an index read-only with the following request using the add index block API: ``` PUT /my_source_index/_block/write ``` The current write index on a data stream cannot be split. In order to split the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be split. The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the `index.number_of_routing_shards` setting. The number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing. For instance, a 5 shard index with `number_of_routing_shards` set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3. A split operation: * Creates a new target index with the same definition as the source index, but with a larger number of primary shards. * Hard-links segments from the source index into the target index. If the file system doesn''t support hard-linking, all segments are copied into the new index, which is a much more time consuming process. * Hashes all documents again, after low level files are created, to delete documents that belong to a different shard. * Recovers the target index as though it were a closed index which had just been re-opened. IMPORTANT: Indices can only be split if they satisfy the following requirements: * The target index must not exist. * The source index must have fewer primary shards than the target index. * The number of primary shards in the target index must be a multiple of the number of primary shards in the source index. * The number of primary shards in the target index must be a divisor of the source index''s `index.number_of_routing_shards`. * The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index. ## Required authorization * Index privileges: `manage` ' operationId: indices-split-1 parameters: - $ref: '#/components/parameters/indices.split-index' - $ref: '#/components/parameters/indices.split-target' - $ref: '#/components/parameters/indices.split-master_timeout' - $ref: '#/components/parameters/indices.split-timeout' - $ref: '#/components/parameters/indices.split-wait_for_active_shards' requestBody: $ref: '#/components/requestBodies/indices.split' responses: '200': $ref: '#/components/responses/indices.split-200' x-state: Generally available; Added in 6.1.0 x-metaTags: - content: Elasticsearch name: product_name /_stats: get: tags: - indices summary: Get index statistics description: 'For data streams, the API retrieves statistics for the stream''s backing indices. By default, the returned statistics are index-level with `primaries` and `total` aggregations. `primaries` are the values for only the primary shards. `total` are the accumulated values for both primary and replica shards. To get shard-level statistics, set the `level` parameter to `shards`. NOTE: When moving to another node, the shard-level statistics for a shard are cleared. Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. ## Required authorization * Index privileges: `monitor` ' operationId: indices-stats parameters: - $ref: '#/components/parameters/indices.stats-completion_fields' - $ref: '#/components/parameters/indices.stats-expand_wildcards' - $ref: '#/components/parameters/indices.stats-fielddata_fields' - $ref: '#/components/parameters/indices.stats-fields' - $ref: '#/components/parameters/indices.stats-forbid_closed_indices' - $ref: '#/components/parameters/indices.stats-groups' - $ref: '#/components/parameters/indices.stats-include_segment_file_sizes' - $ref: '#/components/parameters/indices.stats-include_unloaded_segments' - $ref: '#/components/parameters/indices.stats-level' responses: '200': $ref: '#/components/responses/indices.stats-200' x-state: Generally available; Added in 1.3.0 x-metaTags: - content: Elasticsearch name: product_name /_stats/{metric}: get: tags: - indices summary: Get index statistics description: 'For data streams, the API retrieves statistics for the stream''s backing indices. By default, the returned statistics are index-level with `primaries` and `total` aggregations. `primaries` are the values for only the primary shards. `total` are the accumulated values for both primary and replica shards. To get shard-level statistics, set the `level` parameter to `shards`. NOTE: When moving to another node, the shard-level statistics for a shard are cleared. Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. ## Required authorization * Index privileges: `monitor` ' operationId: indices-stats-1 parameters: - $ref: '#/components/parameters/indices.stats-metric' - $ref: '#/components/parameters/indices.stats-completion_fields' - $ref: '#/components/parameters/indices.stats-expand_wildcards' - $ref: '#/components/parameters/indices.stats-fielddata_fields' - $ref: '#/components/parameters/indices.stats-fields' - $ref: '#/components/parameters/indices.stats-forbid_closed_indices' - $ref: '#/components/parameters/indices.stats-groups' - $ref: '#/components/parameters/indices.stats-include_segment_file_sizes' - $ref: '#/components/parameters/indices.stats-include_unloaded_segments' - $ref: '#/components/parameters/indices.stats-level' responses: '200': $ref: '#/components/responses/indices.stats-200' x-state: Generally available; Added in 1.3.0 x-metaTags: - content: Elasticsearch name: product_name /{index}/_stats: get: tags: - indices summary: Get index statistics description: 'For data streams, the API retrieves statistics for the stream''s backing indices. By default, the returned statistics are index-level with `primaries` and `total` aggregations. `primaries` are the values for only the primary shards. `total` are the accumulated values for both primary and replica shards. To get shard-level statistics, set the `level` parameter to `shards`. NOTE: When moving to another node, the shard-level statistics for a shard are cleared. Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. ## Required authorization * Index privileges: `monitor` ' operationId: indices-stats-2 parameters: - $ref: '#/components/parameters/indices.stats-index' - $ref: '#/components/parameters/indices.stats-completion_fields' - $ref: '#/components/parameters/indices.stats-expand_wildcards' - $ref: '#/components/parameters/indices.stats-fielddata_fields' - $ref: '#/components/parameters/indices.stats-fields' - $ref: '#/components/parameters/indices.stats-forbid_closed_indices' - $ref: '#/components/parameters/indices.stats-groups' - $ref: '#/components/parameters/indices.stats-include_segment_file_sizes' - $ref: '#/components/parameters/indices.stats-include_unloaded_segments' - $ref: '#/components/parameters/indices.stats-level' responses: '200': $ref: '#/components/responses/indices.stats-200' x-state: Generally available; Added in 1.3.0 x-metaTags: - content: Elasticsearch name: product_name /{index}/_stats/{metric}: get: tags: - indices summary: Get index statistics description: 'For data streams, the API retrieves statistics for the stream''s backing indices. By default, the returned statistics are index-level with `primaries` and `total` aggregations. `primaries` are the values for only the primary shards. `total` are the accumulated values for both primary and replica shards. To get shard-level statistics, set the `level` parameter to `shards`. NOTE: When moving to another node, the shard-level statistics for a shard are cleared. Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. ## Required authorization * Index privileges: `monitor` ' operationId: indices-stats-3 parameters: - $ref: '#/components/parameters/indices.stats-index' - $ref: '#/components/parameters/indices.stats-metric' - $ref: '#/components/parameters/indices.stats-completion_fields' - $ref: '#/components/parameters/indices.stats-expand_wildcards' - $ref: '#/components/parameters/indices.stats-fielddata_fields' - $ref: '#/components/parameters/indices.stats-fields' - $ref: '#/components/parameters/indices.stats-forbid_closed_indices' - $ref: '#/components/parameters/indices.stats-groups' - $ref: '#/components/parameters/indices.stats-include_segment_file_sizes' - $ref: '#/components/parameters/indices.stats-include_unloaded_segments' - $ref: '#/components/parameters/indices.stats-level' responses: '200': $ref: '#/components/responses/indices.stats-200' x-state: Generally available; Added in 1.3.0 x-metaTags: - content: Elasticsearch name: product_name /_aliases: post: tags: - indices summary: Create or update an alias description: Adds a data stream or index to an alias. operationId: indices-update-aliases parameters: - in: query name: master_timeout 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.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form - in: query name: timeout description: 'Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form requestBody: content: application/json: schema: type: object properties: actions: description: Actions to perform. type: array items: $ref: '#/components/schemas/indices.update_aliases.Action' examples: IndicesUpdateAliasesExample1: description: An example body for a `POST _aliases` request. value: "{\n \"actions\": [\n {\n \"add\": {\n \"index\": \"logs-nginx.access-prod\",\n \"alias\": \"logs\"\n }\n }\n ]\n}" required: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/_types.AcknowledgedResponseBase' x-state: Generally available; Added in 1.3.0 x-metaTags: - content: Elasticsearch name: product_name /_validate/query: get: tags: - indices summary: Validate a query description: Validates a query without running it. operationId: indices-validate-query parameters: - $ref: '#/components/parameters/indices.validate_query-allow_no_indices' - $ref: '#/components/parameters/indices.validate_query-all_shards' - $ref: '#/components/parameters/indices.validate_query-analyzer' - $ref: '#/components/parameters/indices.validate_query-analyze_wildcard' - $ref: '#/components/parameters/indices.validate_query-default_operator' - $ref: '#/components/parameters/indices.validate_query-df' - $ref: '#/components/parameters/indices.validate_query-expand_wildcards' - $ref: '#/components/parameters/indices.validate_query-explain' - $ref: '#/components/parameters/indices.validate_query-ignore_unavailable' - $ref: '#/components/parameters/indices.validate_query-lenient' - $ref: '#/components/parameters/indices.validate_query-rewrite' - $ref: '#/components/parameters/indices.validate_query-q' - $ref: '#/components/parameters/indices.validate_query-routing' requestBody: $ref: '#/components/requestBodies/indices.validate_query' responses: '200': $ref: '#/components/responses/indices.validate_query-200' x-state: Generally available; Added in 1.3.0 x-metaTags: - content: Elasticsearch name: product_name post: tags: - indices summary: Validate a query description: Validates a query without running it. operationId: indices-validate-query-1 parameters: - $ref: '#/components/parameters/indices.validate_query-allow_no_indices' - $ref: '#/components/parameters/indices.validate_query-all_shards' - $ref: '#/components/parameters/indices.validate_query-analyzer' - $ref: '#/components/parameters/indices.validate_query-analyze_wildcard' - $ref: '#/components/parameters/indices.validate_query-default_operator' - $ref: '#/components/parameters/indices.validate_query-df' - $ref: '#/components/parameters/indices.validate_query-expand_wildcards' - $ref: '#/components/parameters/indices.validate_query-explain' - $ref: '#/components/parameters/indices.validate_query-ignore_unavailable' - $ref: '#/components/parameters/indices.validate_query-lenient' - $ref: '#/components/parameters/indices.validate_query-rewrite' - $ref: '#/components/parameters/indices.validate_query-q' - $ref: '#/components/parameters/indices.validate_query-routing' requestBody: $ref: '#/components/requestBodies/indices.validate_query' responses: '200': $ref: '#/components/responses/indices.validate_query-200' x-state: Generally available; Added in 1.3.0 x-metaTags: - content: Elasticsearch name: product_name /{index}/_validate/query: get: tags: - indices summary: Validate a query description: Validates a query without running it. operationId: indices-validate-query-2 parameters: - $ref: '#/components/parameters/indices.validate_query-index' - $ref: '#/components/parameters/indices.validate_query-allow_no_indices' - $ref: '#/components/parameters/indices.validate_query-all_shards' - $ref: '#/components/parameters/indices.validate_query-analyzer' - $ref: '#/components/parameters/indices.validate_query-analyze_wildcard' - $ref: '#/components/parameters/indices.validate_query-default_operator' - $ref: '#/components/parameters/indices.validate_query-df' - $ref: '#/components/parameters/indices.validate_query-expand_wildcards' - $ref: '#/components/parameters/indices.validate_query-explain' - $ref: '#/components/parameters/indices.validate_query-ignore_unavailable' - $ref: '#/components/parameters/indices.validate_query-lenient' - $ref: '#/components/parameters/indices.validate_query-rewrite' - $ref: '#/components/parameters/indices.validate_query-q' - $ref: '#/components/parameters/indices.validate_query-routing' requestBody: $ref: '#/components/requestBodies/indices.validate_query' responses: '200': $ref: '#/components/responses/indices.validate_query-200' x-state: Generally available; Added in 1.3.0 x-metaTags: - content: Elasticsearch name: product_name post: tags: - indices summary: Validate a query description: Validates a query without running it. operationId: indices-validate-query-3 parameters: - $ref: '#/components/parameters/indices.validate_query-index' - $ref: '#/components/parameters/indices.validate_query-allow_no_indices' - $ref: '#/components/parameters/indices.validate_query-all_shards' - $ref: '#/components/parameters/indices.validate_query-analyzer' - $ref: '#/components/parameters/indices.validate_query-analyze_wildcard' - $ref: '#/components/parameters/indices.validate_query-default_operator' - $ref: '#/components/parameters/indices.validate_query-df' - $ref: '#/components/parameters/indices.validate_query-expand_wildcards' - $ref: '#/components/parameters/indices.validate_query-explain' - $ref: '#/components/parameters/indices.validate_query-ignore_unavailable' - $ref: '#/components/parameters/indices.validate_query-lenient' - $ref: '#/components/parameters/indices.validate_query-rewrite' - $ref: '#/components/parameters/indices.validate_query-q' - $ref: '#/components/parameters/indices.validate_query-routing' requestBody: $ref: '#/components/requestBodies/indices.validate_query' responses: '200': $ref: '#/components/responses/indices.validate_query-200' x-state: Generally available; Added in 1.3.0 x-metaTags: - content: Elasticsearch name: product_name components: schemas: _types.query_dsl.SpanContainingQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: big: description: 'Can be any span query. Matching spans from `big` that contain matches from `little` are returned.' allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanQuery' little: description: 'Can be any span query. Matching spans from `big` that contain matches from `little` are returned.' allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanQuery' required: - big - little _types.query_dsl.TypeQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: value: type: string required: - value _types.analysis.MinHashTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - min_hash bucket_count: description: Number of buckets to which hashes are assigned. Defaults to `512`. type: number hash_count: description: Number of ways to hash each token in the stream. Defaults to `1`. type: number hash_set_size: description: 'Number of hashes to keep from each bucket. Defaults to `1`. Hashes are retained by ascending size, starting with the bucket’s smallest hash first.' type: number with_rotation: description: If `true`, the filter fills empty buckets with the value of the first non-empty bucket to its circular right if the `hash_set_size` is `1`. If the `bucket_count` argument is greater than 1, this parameter defaults to `true`. Otherwise, this parameter defaults to `false`. type: boolean required: - type _types.aggregations.TopHitsAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase' - type: object properties: docvalue_fields: description: Fields for which to return doc values. type: array items: $ref: '#/components/schemas/_types.query_dsl.FieldAndFormat' explain: description: If `true`, returns detailed information about score computation as part of a hit. default: false type: boolean fields: description: 'Array of wildcard (*) patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.' type: array items: $ref: '#/components/schemas/_types.query_dsl.FieldAndFormat' from: description: Starting document offset. default: 0.0 type: number highlight: description: Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results. allOf: - $ref: '#/components/schemas/_global.search._types.Highlight' script_fields: description: Returns the result of one or more script evaluations for each hit. type: object additionalProperties: $ref: '#/components/schemas/_types.ScriptField' size: description: The maximum number of top matching hits to return per bucket. default: 3.0 type: number sort: description: 'Sort order of the top matching hits. By default, the hits are sorted by the score of the main query.' allOf: - $ref: '#/components/schemas/_types.Sort' _source: description: Selects the fields of the source that are returned. allOf: - $ref: '#/components/schemas/_global.search._types.SourceConfig' stored_fields: description: Returns values for the specified stored fields (fields that use the `store` mapping option). allOf: - $ref: '#/components/schemas/_types.Fields' track_scores: description: If `true`, calculates and returns document scores, even if the scores are not used for sorting. default: false type: boolean version: description: If `true`, returns document version as part of a hit. default: false type: boolean seq_no_primary_term: description: If `true`, returns sequence number and primary term of the last modification of each hit. type: boolean _types.aggregations.BucketSelectorAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object properties: script: description: The script to run for this aggregation. allOf: - $ref: '#/components/schemas/_types.Script' _types.query_dsl.CombinedFieldsZeroTerms: type: string enum: - none - all _types.mapping.VersionProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: type: type: string enum: - version required: - type _types.mapping.MatchType: type: string enum: - simple - regex _types.analysis.HunspellTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - hunspell dedup: description: If `true`, duplicate tokens are removed from the filter’s output. Defaults to `true`. type: boolean dictionary: description: 'One or more `.dic` files (e.g, `en_US.dic`, my_custom.dic) to use for the Hunspell dictionary. By default, the `hunspell` filter uses all `.dic` files in the `<$ES_PATH_CONF>/hunspell/` directory specified using the `lang`, `language`, or `locale` parameter.' type: string locale: description: Locale directory used to specify the `.aff` and `.dic` files for a Hunspell dictionary. type: string longest_only: description: If `true`, only the longest stemmed version of each token is included in the output. If `false`, all stemmed versions of the token are included. Defaults to `false`. type: boolean required: - type - locale _types.FieldMemoryUsage: type: object properties: memory_size: allOf: - $ref: '#/components/schemas/_types.ByteSize' memory_size_in_bytes: type: number required: - memory_size_in_bytes _types.aggregations.TermsPartition: type: object properties: num_partitions: description: The number of partitions. type: number partition: description: The partition number for this request. type: number required: - num_partitions - partition _types.query_dsl.GeoBoundingBoxQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: type: deprecated: true allOf: - $ref: '#/components/schemas/_types.query_dsl.GeoExecution' validation_method: description: 'Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude. Set to `COERCE` to also try to infer correct latitude or longitude.' default: '''strict''' allOf: - $ref: '#/components/schemas/_types.query_dsl.GeoValidationMethod' ignore_unmapped: description: 'Set to `true` to ignore an unmapped field and not match any documents for this query. Set to `false` to throw an exception if the field is not mapped.' default: false type: boolean _types.analysis.DanishAnalyzer: type: object properties: type: type: string enum: - danish stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string required: - type _types.SortResults: type: array items: $ref: '#/components/schemas/_types.FieldValue' indices._types.SoftDeletes: type: object properties: enabled: description: Indicates whether soft deletes are enabled on the index. default: true type: boolean retention_lease: description: 'The maximum period to retain a shard history retention lease before it is considered expired. Shard history retention leases ensure that soft deletes are retained during merges on the Lucene index. If a soft delete is merged away before it can be replicated to a follower the following process will fail due to incomplete history on the leader.' allOf: - $ref: '#/components/schemas/indices._types.RetentionLease' _types.mapping.CorePropertyBase: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: copy_to: allOf: - $ref: '#/components/schemas/_types.Fields' store: type: boolean _types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator: type: object properties: doc_count: description: 'The total number of documents that initially created the expectations. It’s required to be greater than or equal to the sum of all values in the buckets_path as this is the originating superset of data to which the term values are correlated.' type: number expectations: description: 'An array of numbers with which to correlate the configured `bucket_path` values. The length of this value must always equal the number of buckets returned by the `bucket_path`.' type: array items: type: number fractions: description: 'An array of fractions to use when averaging and calculating variance. This should be used if the pre-calculated data and the buckets_path have known gaps. The length of fractions, if provided, must equal expectations.' type: array items: type: number required: - doc_count - expectations indices._types.SegmentSortMode: type: string enum: - min - MIN - max - MAX _types.analysis.KuromojiAnalyzer: type: object properties: type: type: string enum: - kuromoji mode: allOf: - $ref: '#/components/schemas/_types.analysis.KuromojiTokenizationMode' user_dictionary: type: string required: - type _types.aggregations.ChildrenAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: type: description: The child type that should be selected. allOf: - $ref: '#/components/schemas/_types.RelationName' _types.EpochTimeUnitMillis: allOf: - $ref: '#/components/schemas/_types.UnitMillis' _types.aggregations.MatrixAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.Aggregation' - type: object properties: fields: description: An array of fields for computing the statistics. allOf: - $ref: '#/components/schemas/_types.Fields' missing: description: 'The value to apply to documents that do not have a value. By default, documents without a value are ignored.' type: object additionalProperties: type: number _types.query_dsl.DisMaxQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: queries: description: 'One or more query clauses. Returned documents must match one or more of these queries. If a document matches multiple queries, Elasticsearch uses the highest relevance score.' type: array items: $ref: '#/components/schemas/_types.query_dsl.QueryContainer' tie_breaker: description: Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses. default: 0.0 type: number required: - queries _types.RecoveryStats: type: object properties: current_as_source: type: number current_as_source_queued: x-state: Generally available; Added in 9.5.0 type: number current_as_target: type: number current_as_target_queued: x-state: Generally available; Added in 9.5.0 type: number current_from_store: x-state: Generally available; Added in 9.5.0 type: number current_from_store_queued: x-state: Generally available; Added in 9.5.0 type: number throttle_time: allOf: - $ref: '#/components/schemas/_types.Duration' throttle_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' required: - current_as_source - current_as_target - throttle_time_in_millis _types.mapping.IntegerNumberProperty: allOf: - $ref: '#/components/schemas/_types.mapping.NumberPropertyBase' - type: object properties: type: type: string enum: - integer null_value: type: number required: - type _types.aggregations.SamplerAggregationExecutionHint: type: string enum: - map - global_ordinals - bytes_hash indices.put_index_template.IndexTemplateMapping: type: object properties: aliases: description: 'Aliases to add. If the index template includes a `data_stream` object, these are data stream aliases. Otherwise, these are index aliases. Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options.' type: object additionalProperties: $ref: '#/components/schemas/indices._types.Alias' mappings: description: 'Mapping for fields in the index. If specified, this mapping can include field names, field data types, and mapping parameters.' allOf: - $ref: '#/components/schemas/_types.mapping.TypeMapping' settings: description: Configuration options for the index. allOf: - $ref: '#/components/schemas/indices._types.IndexSettings' lifecycle: x-state: Generally available; Added in 8.11.0 allOf: - $ref: '#/components/schemas/indices._types.DataStreamLifecycle' data_stream_options: x-state: Generally available; Added in 8.19.0 oneOf: - $ref: '#/components/schemas/indices._types.DataStreamOptionsTemplate' - type: - string - 'null' _types.aggregations.MovingPercentilesAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object properties: window: description: The size of window to "slide" across the histogram. type: number shift: description: 'By default, the window consists of the last n values excluding the current bucket. Increasing `shift` by 1, moves the starting window position by 1 to the right.' default: 0.0 type: number keyed: type: boolean _types.aggregations.HoltWintersModelSettings: type: object properties: alpha: type: number beta: type: number gamma: type: number pad: type: boolean period: type: number type: allOf: - $ref: '#/components/schemas/_types.aggregations.HoltWintersType' _types.aggregations.HistogramAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: extended_bounds: description: Enables extending the bounds of the histogram beyond the data itself. allOf: - $ref: '#/components/schemas/_types.aggregations.ExtendedBoundsdouble' hard_bounds: description: 'Limits the range of buckets in the histogram. It is particularly useful in the case of open data ranges that can result in a very large number of buckets.' allOf: - $ref: '#/components/schemas/_types.aggregations.ExtendedBoundsdouble' field: description: The name of the field to aggregate on. allOf: - $ref: '#/components/schemas/_types.Field' interval: description: 'The interval for the buckets. Must be a positive decimal.' type: number min_doc_count: description: 'Only returns buckets that have `min_doc_count` number of documents. By default, the response will fill gaps in the histogram with empty buckets.' type: number missing: description: 'The value to apply to documents that do not have a value. By default, documents without a value are ignored.' type: number offset: description: 'By default, the bucket keys start with 0 and then continue in even spaced steps of `interval`. The bucket boundaries can be shifted by using the `offset` option.' type: number order: description: 'The sort order of the returned buckets. By default, the returned buckets are sorted by their key ascending.' allOf: - $ref: '#/components/schemas/_types.aggregations.AggregateOrder' script: allOf: - $ref: '#/components/schemas/_types.Script' format: type: string keyed: description: If `true`, returns buckets as a hash instead of an array, keyed by the bucket keys. default: false type: boolean _types.GeoTilePrecision: type: number _types.mapping.DataStreamTimestamp: type: object properties: enabled: type: boolean required: - enabled _types.aggregations.DateRangeAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: field: description: The date field whose values are use to build ranges. allOf: - $ref: '#/components/schemas/_types.Field' format: description: The date format used to format `from` and `to` in the response. type: string missing: description: 'The value to apply to documents that do not have a value. By default, documents without a value are ignored.' allOf: - $ref: '#/components/schemas/_types.aggregations.Missing' ranges: description: Array of date ranges. type: array items: $ref: '#/components/schemas/_types.aggregations.DateRangeExpression' time_zone: description: Time zone used to convert dates from another time zone to UTC. allOf: - $ref: '#/components/schemas/_types.TimeZone' keyed: description: Set to `true` to associate a unique string key with each bucket and returns the ranges as a hash rather than an array. type: boolean indices._types.MappingLimitSettingsFieldNameLength: type: object properties: limit: description: 'Setting for the maximum length of a field name. This setting isn’t really something that addresses mappings explosion but might still be useful if you want to limit the field length. It usually shouldn’t be necessary to set this setting. The default is okay unless a user starts to add a huge number of fields with really long names. Default is `Long.MAX_VALUE` (no limit).' type: number _types.analysis.CompoundWordTokenFilterBase: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: max_subword_size: description: Maximum subword character length. Longer subword tokens are excluded from the output. Defaults to `15`. type: number min_subword_size: description: Minimum subword character length. Shorter subword tokens are excluded from the output. Defaults to `2`. type: number min_word_size: description: Minimum word character length. Shorter word tokens are excluded from the output. Defaults to `5`. type: number only_longest_match: description: If `true`, only include the longest matching subword. Defaults to `false`. type: boolean word_list: description: 'A list of subwords to look for in the token stream. If found, the subword is included in the token output. Either this parameter or `word_list_path` must be specified.' type: array items: type: string word_list_path: description: 'Path to a file that contains a list of subwords to find in the token stream. If found, the subword is included in the token output. This path must be absolute or relative to the config location, and the file must be UTF-8 encoded. Each token in the file must be separated by a line break. Either this parameter or `word_list` must be specified.' type: string indices.get_alias._types.IndexAliases: type: object properties: aliases: type: object additionalProperties: $ref: '#/components/schemas/indices._types.AliasDefinition' required: - aliases indices._types.SettingsSimilarityDfr: type: object properties: type: type: string enum: - DFR after_effect: allOf: - $ref: '#/components/schemas/_types.DFRAfterEffect' basic_model: allOf: - $ref: '#/components/schemas/_types.DFRBasicModel' normalization: allOf: - $ref: '#/components/schemas/_types.Normalization' required: - type - after_effect - basic_model - normalization _types.Ip: type: string _types.aggregations.StringStatsAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase' - type: object properties: show_distribution: description: Shows the probability distribution for all characters. default: false type: boolean indices._types.TranslogRetention: type: object properties: size: description: 'This controls the total size of translog files to keep for each shard. Keeping more translog files increases the chance of performing an operation based sync when recovering a replica. If the translog files are not sufficient, replica recovery will fall back to a file based sync. This setting is ignored, and should not be set, if soft deletes are enabled. Soft deletes are enabled by default in indices created in Elasticsearch versions 7.0.0 and later.' default: 512mb allOf: - $ref: '#/components/schemas/_types.ByteSize' age: description: 'This controls the maximum duration for which translog files are kept by each shard. Keeping more translog files increases the chance of performing an operation based sync when recovering replicas. If the translog files are not sufficient, replica recovery will fall back to a file based sync. This setting is ignored, and should not be set, if soft deletes are enabled. Soft deletes are enabled by default in indices created in Elasticsearch versions 7.0.0 and later.' default: 12h allOf: - $ref: '#/components/schemas/_types.Duration' indices._types.SamplingMethod: type: string enum: - aggregate - last_value _types.byte: type: number _types.aggregations.TTestType: type: string enum: - paired - homoscedastic - heteroscedastic _types.Host: type: string _types.TextSimilarityReranker: allOf: - $ref: '#/components/schemas/_types.RetrieverBase' - type: object properties: retriever: description: The nested retriever which will produce the first-level results, that will later be used for reranking. allOf: - $ref: '#/components/schemas/_types.RetrieverContainer' rank_window_size: description: This value determines how many documents we will consider from the nested retriever. type: number inference_id: description: Unique identifier of the inference endpoint created using the inference API. type: string inference_text: description: The text snippet used as the basis for similarity comparison. type: string field: description: The document field to be used for text similarity comparisons. This field should contain the text that will be evaluated against the inference_text. type: string chunk_rescorer: description: Whether to rescore on only the best matching chunks. x-state: Generally available; Added in 9.2.0 allOf: - $ref: '#/components/schemas/_types.ChunkRescorer' required: - retriever - inference_text - field _types.aggregations.ParentAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: type: description: The child type that should be selected. allOf: - $ref: '#/components/schemas/_types.RelationName' _types.analysis.BulgarianAnalyzer: type: object properties: type: type: string enum: - bulgarian stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type _types.aggregations.MaxBucketAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object _global.search._types.FieldCollapse: type: object properties: field: description: The field to collapse the result set on allOf: - $ref: '#/components/schemas/_types.Field' inner_hits: description: The number of inner hits and their sort order oneOf: - $ref: '#/components/schemas/_global.search._types.InnerHits' - type: array items: $ref: '#/components/schemas/_global.search._types.InnerHits' max_concurrent_group_searches: description: The number of concurrent requests allowed to retrieve the inner_hits per group type: number collapse: allOf: - $ref: '#/components/schemas/_global.search._types.FieldCollapse' required: - field indices.recovery.RecoveryStartStatus: type: object properties: check_index_time: allOf: - $ref: '#/components/schemas/_types.Duration' check_index_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' total_time: allOf: - $ref: '#/components/schemas/_types.Duration' total_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' required: - check_index_time_in_millis - total_time_in_millis _types.mapping.GeoShapeProperty: description: 'The `geo_shape` data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles and polygons.' allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: coerce: type: boolean ignore_malformed: type: boolean ignore_z_value: type: boolean index: type: boolean orientation: allOf: - $ref: '#/components/schemas/_types.mapping.GeoOrientation' strategy: allOf: - $ref: '#/components/schemas/_types.mapping.GeoStrategy' type: type: string enum: - geo_shape required: - type _types.DateTime: description: 'A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.' oneOf: - type: string - $ref: '#/components/schemas/_types.EpochTimeUnitMillis' _types.query_dsl.RangeQueryBase: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: relation: description: Indicates how the range query matches values for `range` fields. default: intersects allOf: - $ref: '#/components/schemas/_types.query_dsl.RangeRelation' gt: description: Greater than. type: object gte: description: Greater than or equal to. type: object lt: description: Less than. type: object lte: description: Less than or equal to. type: object _types.query_dsl.NumericDecayFunction: allOf: - $ref: '#/components/schemas/_types.query_dsl.DecayFunctionBasedoubledouble' - type: object _types.analysis.StemmerOverrideTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - stemmer_override rules: description: A list of mapping rules to use. type: array items: type: string rules_path: description: A path (either relative to `config` location, or absolute) to a list of mappings. type: string required: - type _types.mapping.Subobjects: type: string enum: - 'true' - 'false' _types.aggregations.FormattableMetricAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase' - type: object properties: format: type: string _types.DataStreamNames: oneOf: - $ref: '#/components/schemas/_types.DataStreamName' - type: array items: $ref: '#/components/schemas/_types.DataStreamName' indices._types.RetentionLease: type: object properties: period: allOf: - $ref: '#/components/schemas/_types.Duration' required: - period indices.update_aliases.AddAction: type: object properties: alias: description: 'Alias for the action. Index alias names support date math.' allOf: - $ref: '#/components/schemas/_types.IndexAlias' aliases: description: 'Aliases for the action. Index alias names support date math.' oneOf: - $ref: '#/components/schemas/_types.IndexAlias' - type: array items: $ref: '#/components/schemas/_types.IndexAlias' filter: description: Query used to limit documents the alias can access. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' index: description: 'Data stream or index for the action. Supports wildcards (`*`).' allOf: - $ref: '#/components/schemas/_types.IndexName' indices: description: 'Data streams or indices for the action. Supports wildcards (`*`).' allOf: - $ref: '#/components/schemas/_types.Indices' index_routing: description: 'Value used to route indexing operations to a specific shard. If specified, this overwrites the `routing` value for indexing operations. Data stream aliases don’t support this parameter.' type: string is_hidden: description: If `true`, the alias is hidden. default: false type: boolean is_write_index: description: If `true`, sets the write index or data stream for the alias. type: boolean routing: description: 'Value used to route indexing and search operations to a specific shard. Data stream aliases don’t support this parameter.' type: string search_routing: description: 'Value used to route search operations to a specific shard. If specified, this overwrites the `routing` value for search operations. Data stream aliases don’t support this parameter.' type: string must_exist: description: If `true`, the alias must exist to perform the action. default: false type: boolean _types.analysis.TokenizerDefinition: discriminator: propertyName: type mapping: char_group: '#/components/schemas/_types.analysis.CharGroupTokenizer' classic: '#/components/schemas/_types.analysis.ClassicTokenizer' edge_ngram: '#/components/schemas/_types.analysis.EdgeNGramTokenizer' icu_tokenizer: '#/components/schemas/_types.analysis.IcuTokenizer' keyword: '#/components/schemas/_types.analysis.KeywordTokenizer' kuromoji_tokenizer: '#/components/schemas/_types.analysis.KuromojiTokenizer' letter: '#/components/schemas/_types.analysis.LetterTokenizer' lowercase: '#/components/schemas/_types.analysis.LowercaseTokenizer' ngram: '#/components/schemas/_types.analysis.NGramTokenizer' nori_tokenizer: '#/components/schemas/_types.analysis.NoriTokenizer' path_hierarchy: '#/components/schemas/_types.analysis.PathHierarchyTokenizer' pattern: '#/components/schemas/_types.analysis.PatternTokenizer' simple_pattern: '#/components/schemas/_types.analysis.SimplePatternTokenizer' simple_pattern_split: '#/components/schemas/_types.analysis.SimplePatternSplitTokenizer' standard: '#/components/schemas/_types.analysis.StandardTokenizer' thai: '#/components/schemas/_types.analysis.ThaiTokenizer' uax_url_email: '#/components/schemas/_types.analysis.UaxEmailUrlTokenizer' whitespace: '#/components/schemas/_types.analysis.WhitespaceTokenizer' oneOf: - $ref: '#/components/schemas/_types.analysis.CharGroupTokenizer' - $ref: '#/components/schemas/_types.analysis.ClassicTokenizer' - $ref: '#/components/schemas/_types.analysis.EdgeNGramTokenizer' - $ref: '#/components/schemas/_types.analysis.KeywordTokenizer' - $ref: '#/components/schemas/_types.analysis.LetterTokenizer' - $ref: '#/components/schemas/_types.analysis.LowercaseTokenizer' - $ref: '#/components/schemas/_types.analysis.NGramTokenizer' - $ref: '#/components/schemas/_types.analysis.PathHierarchyTokenizer' - $ref: '#/components/schemas/_types.analysis.PatternTokenizer' - $ref: '#/components/schemas/_types.analysis.SimplePatternTokenizer' - $ref: '#/components/schemas/_types.analysis.SimplePatternSplitTokenizer' - $ref: '#/components/schemas/_types.analysis.StandardTokenizer' - $ref: '#/components/schemas/_types.analysis.ThaiTokenizer' - $ref: '#/components/schemas/_types.analysis.UaxEmailUrlTokenizer' - $ref: '#/components/schemas/_types.analysis.WhitespaceTokenizer' - $ref: '#/components/schemas/_types.analysis.IcuTokenizer' - $ref: '#/components/schemas/_types.analysis.KuromojiTokenizer' - $ref: '#/components/schemas/_types.analysis.NoriTokenizer' indices._types.IndexState: type: object properties: aliases: type: object additionalProperties: $ref: '#/components/schemas/indices._types.Alias' mappings: allOf: - $ref: '#/components/schemas/_types.mapping.TypeMapping' settings: allOf: - $ref: '#/components/schemas/indices._types.IndexSettings' defaults: description: Default settings, included when the request's `include_default` is `true`. allOf: - $ref: '#/components/schemas/indices._types.IndexSettings' data_stream: allOf: - $ref: '#/components/schemas/_types.DataStreamName' lifecycle: description: Data stream lifecycle applicable if this is a data stream. x-state: Generally available; Added in 8.11.0 allOf: - $ref: '#/components/schemas/indices._types.DataStreamLifecycle' _types.query_dsl.UntypedRangeQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.RangeQueryBase' - type: object properties: format: description: Date format used to convert `date` values in the query. allOf: - $ref: '#/components/schemas/_types.DateFormat' time_zone: description: Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC. allOf: - $ref: '#/components/schemas/_types.TimeZone' _types.CompletionStats: type: object properties: size_in_bytes: description: Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes. type: number size: description: Total amount of memory used for completion across all shards assigned to selected nodes. allOf: - $ref: '#/components/schemas/_types.ByteSize' fields: type: object additionalProperties: $ref: '#/components/schemas/_types.FieldSizeUsage' required: - size_in_bytes _types.IndexName: type: string _types.aggregations.GeoLineSort: type: object properties: field: description: The name of the numeric field to use as the sort key for ordering the points. allOf: - $ref: '#/components/schemas/_types.Field' required: - field _types.mapping.SizeField: type: object properties: enabled: type: boolean required: - enabled indices.segments.IndexSegment: type: object properties: shards: type: object additionalProperties: oneOf: - $ref: '#/components/schemas/indices.segments.ShardsSegment' - type: array items: $ref: '#/components/schemas/indices.segments.ShardsSegment' required: - shards _types.mapping.LongRangeProperty: allOf: - $ref: '#/components/schemas/_types.mapping.RangePropertyBase' - type: object properties: type: type: string enum: - long_range required: - type _types.IndexingStats: type: object properties: index_current: type: number delete_current: type: number delete_time: allOf: - $ref: '#/components/schemas/_types.Duration' delete_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' delete_total: type: number is_throttled: type: boolean noop_update_total: type: number throttle_time: allOf: - $ref: '#/components/schemas/_types.Duration' throttle_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' index_time: allOf: - $ref: '#/components/schemas/_types.Duration' index_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' index_total: type: number index_failed: type: number index_failed_due_to_version_conflict: type: number types: type: object additionalProperties: $ref: '#/components/schemas/_types.IndexingStats' write_load: type: number recent_write_load: type: number peak_write_load: type: number required: - index_current - delete_current - delete_time_in_millis - delete_total - is_throttled - noop_update_total - throttle_time_in_millis - index_time_in_millis - index_total - index_failed - index_failed_due_to_version_conflict _types.analysis.KuromojiPartOfSpeechTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - kuromoji_part_of_speech stoptags: type: array items: type: string required: - type - stoptags _types.mapping.FieldAliasProperty: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: path: allOf: - $ref: '#/components/schemas/_types.Field' type: type: string enum: - alias required: - type cluster.stats.DenseVectorStats: type: object properties: value_count: type: number off_heap: allOf: - $ref: '#/components/schemas/cluster.stats.DenseVectorOffHeapStats' required: - value_count _types.Uuid: type: string _types.aggregations.MultiTermLookup: allOf: - type: object properties: missing: description: 'The value to apply to documents that do not have a value. By default, documents without a value are ignored.' allOf: - $ref: '#/components/schemas/_types.aggregations.Missing' - type: object properties: field: description: 'A field from which to retrieve terms. It is required if `script` is not provided.' allOf: - $ref: '#/components/schemas/_types.Field' script: description: 'A script to calculate terms to aggregate on. It is required if `field` is not provided.' allOf: - $ref: '#/components/schemas/_types.Script' minProperties: 1 maxProperties: 1 _types.query_dsl.DecayFunctionBaseGeoLocationDistance: type: object properties: multi_value_mode: description: Determines how the distance is calculated when a field used for computing the decay contains multiple values. default: min allOf: - $ref: '#/components/schemas/_types.query_dsl.MultiValueMode' _types.aggregations.CompositeAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: after: description: When paginating, use the `after_key` value returned in the previous response to retrieve the next page. allOf: - $ref: '#/components/schemas/_types.aggregations.CompositeAggregateKey' size: description: The number of composite buckets that should be returned. default: 10.0 type: number sources: description: 'The value sources used to build composite buckets. Keys are returned in the order of the `sources` definition.' type: array items: type: object additionalProperties: $ref: '#/components/schemas/_types.aggregations.CompositeAggregationSource' minProperties: 1 maxProperties: 1 _types.analysis.HyphenationDecompounderTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.CompoundWordTokenFilterBase' - type: object properties: type: type: string enum: - hyphenation_decompounder hyphenation_patterns_path: description: 'Path to an Apache FOP (Formatting Objects Processor) XML hyphenation pattern file. This path must be absolute or relative to the `config` location. Only FOP v1.2 compatible files are supported.' type: string no_sub_matches: description: If `true`, do not match sub tokens in tokens that are in the word list. Defaults to `false`. type: boolean no_overlapping_matches: description: If `true`, do not allow overlapping tokens. Defaults to `false`. type: boolean required: - type - hyphenation_patterns_path _types.query_dsl.SemanticQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: field: description: The field to query, which must be a semantic_text field type type: string query: description: The query text type: string required: - field - query _types.aggregations.InferenceAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object properties: model_id: description: The ID or alias for the trained model. allOf: - $ref: '#/components/schemas/_types.Name' inference_config: description: Contains the inference type and its options. allOf: - $ref: '#/components/schemas/_types.aggregations.InferenceConfigContainer' required: - model_id _types.analysis.ArabicAnalyzer: type: object properties: type: type: string enum: - arabic stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type _types.aggregations.HoltWintersMovingAverageAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MovingAverageAggregationBase' - type: object properties: model: type: string enum: - holt_winters settings: allOf: - $ref: '#/components/schemas/_types.aggregations.HoltWintersModelSettings' required: - model - settings _types.query_dsl.TextQueryType: type: string enum: - best_fields - most_fields - cross_fields - phrase - phrase_prefix - bool_prefix _types.analysis.KuromojiIterationMarkCharFilter: allOf: - $ref: '#/components/schemas/_types.analysis.CharFilterBase' - type: object properties: type: type: string enum: - kuromoji_iteration_mark normalize_kana: type: boolean normalize_kanji: type: boolean required: - type - normalize_kana - normalize_kanji _types.analysis.StopWords: description: 'Language value, such as _arabic_ or _thai_. Defaults to _english_. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words.' oneOf: - $ref: '#/components/schemas/_types.analysis.StopWordLanguage' - type: array items: type: string indices.stats.ShardRetentionLeases: type: object properties: primary_term: type: number version: allOf: - $ref: '#/components/schemas/_types.VersionNumber' leases: type: array items: $ref: '#/components/schemas/indices.stats.ShardLease' required: - primary_term - version - leases _types.analysis.SimplePatternSplitTokenizer: allOf: - $ref: '#/components/schemas/_types.analysis.TokenizerBase' - type: object properties: type: type: string enum: - simple_pattern_split pattern: type: string required: - type indices._types.IndexTemplateSummary: type: object properties: aliases: description: 'Aliases to add. If the index template includes a `data_stream` object, these are data stream aliases. Otherwise, these are index aliases. Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options.' type: object additionalProperties: $ref: '#/components/schemas/indices._types.Alias' mappings: description: 'Mapping for fields in the index. If specified, this mapping can include field names, field data types, and mapping parameters.' allOf: - $ref: '#/components/schemas/_types.mapping.TypeMapping' settings: description: Configuration options for the index. allOf: - $ref: '#/components/schemas/indices._types.IndexSettings' lifecycle: x-state: Generally available; Added in 8.11.0 allOf: - $ref: '#/components/schemas/indices._types.DataStreamLifecycle' data_stream_options: x-state: Generally available; Added in 8.19.0 allOf: - $ref: '#/components/schemas/indices._types.DataStreamOptions' _types.mapping.PassthroughObjectProperty: allOf: - $ref: '#/components/schemas/_types.mapping.CorePropertyBase' - type: object properties: type: type: string enum: - passthrough enabled: type: boolean priority: type: number time_series_dimension: type: boolean _types.aggregations.ScriptedMetricAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase' - type: object properties: combine_script: description: 'Runs once on each shard after document collection is complete. Allows the aggregation to consolidate the state returned from each shard.' allOf: - $ref: '#/components/schemas/_types.Script' init_script: description: 'Runs prior to any collection of documents. Allows the aggregation to set up any initial state.' allOf: - $ref: '#/components/schemas/_types.Script' map_script: description: 'Run once per document collected. If no `combine_script` is specified, the resulting state needs to be stored in the `state` object.' allOf: - $ref: '#/components/schemas/_types.Script' params: description: 'A global object with script parameters for `init`, `map` and `combine` scripts. It is shared between the scripts.' type: object additionalProperties: type: object reduce_script: description: 'Runs once on the coordinating node after all shards have returned their results. The script is provided with access to a variable `states`, which is an array of the result of the `combine_script` on each shard.' allOf: - $ref: '#/components/schemas/_types.Script' _types.analysis.ScandinavianNormalizationTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - scandinavian_normalization required: - type _types.aggregations.StatsBucketAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object _types.query_dsl.RangeQueryBaselong: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: relation: description: Indicates how the range query matches values for `range` fields. default: intersects allOf: - $ref: '#/components/schemas/_types.query_dsl.RangeRelation' gt: description: Greater than. type: number gte: description: Greater than or equal to. type: number lt: description: Less than. type: number lte: description: Less than or equal to. type: number _types.mapping.RankVectorProperty: description: Technical preview allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: type: type: string enum: - rank_vectors element_type: allOf: - $ref: '#/components/schemas/_types.mapping.RankVectorElementType' dims: type: number required: - type indices._types.DataStreamVisibility: type: object properties: hidden: type: boolean allow_custom_routing: type: boolean failure_store: type: boolean _types.mapping.ShapeProperty: description: 'The `shape` data type facilitates the indexing of and searching with arbitrary `x, y` cartesian shapes such as rectangles and polygons.' allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: coerce: type: boolean ignore_malformed: type: boolean ignore_z_value: type: boolean orientation: allOf: - $ref: '#/components/schemas/_types.mapping.GeoOrientation' type: type: string enum: - shape required: - type _types.mapping.IcuCollationProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: type: type: string enum: - icu_collation_keyword norms: type: boolean index_options: allOf: - $ref: '#/components/schemas/_types.mapping.IndexOptions' index: description: Should the field be searchable? type: boolean null_value: description: Accepts a string value which is substituted for any explicit null values. Defaults to null, which means the field is treated as missing. type: string rules: type: string language: type: string country: type: string variant: type: string strength: allOf: - $ref: '#/components/schemas/_types.analysis.IcuCollationStrength' decomposition: allOf: - $ref: '#/components/schemas/_types.analysis.IcuCollationDecomposition' alternate: allOf: - $ref: '#/components/schemas/_types.analysis.IcuCollationAlternate' case_level: type: boolean case_first: allOf: - $ref: '#/components/schemas/_types.analysis.IcuCollationCaseFirst' numeric: type: boolean variable_top: type: string hiragana_quaternary_mode: type: boolean required: - type _types.analysis.DictionaryDecompounderTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.CompoundWordTokenFilterBase' - type: object properties: type: type: string enum: - dictionary_decompounder required: - type _types.analysis.UppercaseTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - uppercase required: - type _types.StoreStats: type: object properties: size: description: Total size of all shards assigned to selected nodes. allOf: - $ref: '#/components/schemas/_types.ByteSize' size_in_bytes: description: Total size, in bytes, of all shards assigned to selected nodes. type: number reserved: description: A prediction of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. allOf: - $ref: '#/components/schemas/_types.ByteSize' reserved_in_bytes: description: A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. type: number total_data_set_size: description: 'Total data set size of all shards assigned to selected nodes. This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.' allOf: - $ref: '#/components/schemas/_types.ByteSize' total_data_set_size_in_bytes: description: 'Total data set size, in bytes, of all shards assigned to selected nodes. This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.' type: number required: - size_in_bytes - reserved_in_bytes _types.mapping.NestedProperty: allOf: - $ref: '#/components/schemas/_types.mapping.CorePropertyBase' - type: object properties: enabled: type: boolean include_in_parent: type: boolean include_in_root: type: boolean type: type: string enum: - nested required: - type indices.update_aliases.Action: type: object properties: add: description: 'Adds a data stream or index to an alias. If the alias doesn’t exist, the `add` action creates it.' allOf: - $ref: '#/components/schemas/indices.update_aliases.AddAction' remove: description: Removes a data stream or index from an alias. allOf: - $ref: '#/components/schemas/indices.update_aliases.RemoveAction' remove_index: description: 'Deletes an index. You cannot use this action on aliases or data streams.' allOf: - $ref: '#/components/schemas/indices.update_aliases.RemoveIndexAction' minProperties: 1 maxProperties: 1 _types.aggregations.BucketPathAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.Aggregation' - type: object properties: buckets_path: description: Path to the buckets that contain one set of values to correlate. allOf: - $ref: '#/components/schemas/_types.aggregations.BucketsPath' _types.mapping.FlattenedProperty: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: boost: type: number depth_limit: type: number doc_values: type: boolean eager_global_ordinals: type: boolean index: type: boolean index_options: allOf: - $ref: '#/components/schemas/_types.mapping.IndexOptions' null_value: type: string preserve_leaf_arrays: description: 'How leaf arrays are represented in synthetic source. When set to `lossy`, leaf arrays are sorted, de-nulled, and deduplicated in the returned synthetic source. When set to `exact`, leaf arrays preserve order, nulls, and duplicates.' allOf: - $ref: '#/components/schemas/_types.mapping.PreserveLeafArrays' similarity: type: string split_queries_on_whitespace: type: boolean time_series_dimensions: type: array items: type: string type: type: string enum: - flattened required: - type _types.analysis.DelimitedPayloadEncoding: type: string enum: - int - float - identity _types.aggregations.AggregationRange: type: object properties: from: description: Start of the range (inclusive). oneOf: - type: number - type: - string - 'null' key: description: Custom key to return the range with. type: string to: description: End of the range (exclusive). oneOf: - type: number - type: - string - 'null' _types.DateFormat: type: string _types.analysis.CustomNormalizer: type: object properties: type: type: string enum: - custom char_filter: type: array items: type: string filter: type: array items: type: string required: - type _types.DiversifyRetriever: allOf: - $ref: '#/components/schemas/_types.RetrieverBase' - type: object properties: type: description: The diversification strategy to apply. allOf: - $ref: '#/components/schemas/_types.DiversifyRetrieverTypes' field: description: The document field on which to diversify results on. type: string retriever: description: The nested retriever whose results will be diversified. allOf: - $ref: '#/components/schemas/_types.RetrieverContainer' size: description: The number of top documents to return after diversification. type: number rank_window_size: description: The number of top documents from the nested retriever to consider for diversification. type: number query_vector: description: The query vector used for diversification. allOf: - $ref: '#/components/schemas/_types.QueryVector' query_vector_builder: description: a dense vector query vector builder to use instead of a static query_vector allOf: - $ref: '#/components/schemas/_types.QueryVectorBuilder' lambda: description: Controls the trade-off between relevance and diversity for MMR. A value of 0.0 focuses solely on diversity, while a value of 1.0 focuses solely on relevance. Required for MMR type: number required: - type - field - retriever _types.query_dsl.TextExpansionQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: model_id: description: The text expansion NLP model to use type: string model_text: description: The query text type: string pruning_config: description: Token pruning configurations x-state: Experimental; Added in 8.13.0 allOf: - $ref: '#/components/schemas/_types.TokenPruningConfig' required: - model_id - model_text _types.mapping.PropertyBase: type: object properties: meta: description: Metadata about the field. type: object additionalProperties: type: string properties: type: object additionalProperties: $ref: '#/components/schemas/_types.mapping.Property' ignore_above: type: number dynamic: allOf: - $ref: '#/components/schemas/_types.mapping.DynamicMapping' fields: type: object additionalProperties: $ref: '#/components/schemas/_types.mapping.Property' synthetic_source_keep: allOf: - $ref: '#/components/schemas/_types.mapping.SyntheticSourceKeepEnum' _types.analysis.ClassicTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - classic required: - type _types.analysis.SimplePatternTokenizer: allOf: - $ref: '#/components/schemas/_types.analysis.TokenizerBase' - type: object properties: type: type: string enum: - simple_pattern pattern: type: string required: - type _types.mapping.DenseVectorElementType: type: string enum: - bit - byte - float - bfloat16 _types.analysis.SimpleAnalyzer: type: object properties: type: type: string enum: - simple version: deprecated: true allOf: - $ref: '#/components/schemas/_types.VersionString' required: - type _types.HealthStatus: type: string enum: - green - GREEN - yellow - YELLOW - red - RED - unknown - unavailable _types.analysis.MultiplexerTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - multiplexer filters: description: A list of token filters to apply to incoming tokens. type: array items: type: string preserve_original: description: If `true` (the default) then emit the original token in addition to the filtered tokens. allOf: - $ref: '#/components/schemas/_spec_utils.Stringifiedboolean' required: - type - filters _types.aggregations.ExtendedStatsBucketAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object properties: sigma: description: The number of standard deviations above/below the mean to display. type: number _types.analysis.CjkAnalyzer: type: object properties: type: type: string enum: - cjk stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string required: - type _types.analysis.TrimTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - trim required: - type _types.analysis.PersianNormalizationTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - persian_normalization required: - type _types.analysis.IndicNormalizationTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - indic_normalization required: - type _types.GeoHash: type: string _types.query_dsl.WildcardQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: case_insensitive: description: Allows case insensitive matching of the pattern with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field’s mapping. x-state: Generally available; Added in 7.10.0 type: boolean rewrite: description: Method used to rewrite the query. allOf: - $ref: '#/components/schemas/_types.MultiTermQueryRewrite' value: description: Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set. type: string wildcard: description: Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set. type: string _global.search._types.HighlighterOrder: type: string enum: - score _types.query_dsl.FuzzyQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: max_expansions: description: Maximum number of variations created. default: 50.0 type: number prefix_length: description: Number of beginning characters left unchanged when creating expansions. default: 0.0 type: number rewrite: description: Number of beginning characters left unchanged when creating expansions. default: constant_score allOf: - $ref: '#/components/schemas/_types.MultiTermQueryRewrite' transpositions: description: Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`). default: true type: boolean fuzziness: description: Maximum edit distance allowed for matching. allOf: - $ref: '#/components/schemas/_types.Fuzziness' value: description: Term you wish to find in the provided field. oneOf: - type: string - type: number - type: boolean required: - value _types.Id: type: string _types.InnerRetriever: type: object properties: retriever: allOf: - $ref: '#/components/schemas/_types.RetrieverContainer' weight: type: number normalizer: allOf: - $ref: '#/components/schemas/_types.ScoreNormalizer' required: - retriever - weight - normalizer _types.ShardFailure: type: object properties: index: allOf: - $ref: '#/components/schemas/_types.IndexName' node: type: string reason: allOf: - $ref: '#/components/schemas/_types.ErrorCause' shard: type: number status: type: string primary: type: boolean required: - reason _types.query_dsl.SparseVectorQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-sparse-vector-query allOf: - type: object properties: field: description: 'The name of the field that contains the token-weight pairs to be searched against. This field must be a mapped sparse_vector field.' allOf: - $ref: '#/components/schemas/_types.Field' query: description: 'The query text you want to use for search. If inference_id is specified, query must also be specified.' type: string prune: description: 'Whether to perform pruning, omitting the non-significant tokens from the query to improve query performance. If prune is true but the pruning_config is not specified, pruning will occur but default values will be used. Default: false' x-state: Generally available; Added in 8.15.0 type: boolean pruning_config: description: 'Optional pruning configuration. If enabled, this will omit non-significant tokens from the query in order to improve query performance. This is only used if prune is set to true. If prune is set to true but pruning_config is not specified, default values will be used.' x-state: Generally available; Added in 8.15.0 allOf: - $ref: '#/components/schemas/_types.TokenPruningConfig' required: - field - type: object properties: query_vector: description: 'Dictionary of precomputed sparse vectors and their associated weights. Only one of inference_id or query_vector may be supplied in a request.' type: object additionalProperties: type: number inference_id: description: 'The inference ID to use to convert the query text into token-weight pairs. It must be the same inference ID that was used to create the tokens from the input text. Only one of inference_id and query_vector is allowed. If inference_id is specified, query must also be specified. Only one of inference_id or query_vector may be supplied in a request.' allOf: - $ref: '#/components/schemas/_types.Id' minProperties: 1 maxProperties: 1 _types.analysis.PhoneticNameType: type: string enum: - generic - ashkenazi - sephardic _types.SlicedScroll: type: object properties: field: allOf: - $ref: '#/components/schemas/_types.Field' id: allOf: - $ref: '#/components/schemas/_types.Id' max: type: number required: - id - max _types.aggregations.SignificantTextAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: background_filter: description: A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' chi_square: description: Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. allOf: - $ref: '#/components/schemas/_types.aggregations.ChiSquareHeuristic' exclude: description: Values to exclude. allOf: - $ref: '#/components/schemas/_types.aggregations.TermsExclude' execution_hint: description: Determines whether the aggregation will use field values directly or global ordinals. allOf: - $ref: '#/components/schemas/_types.aggregations.TermsAggregationExecutionHint' field: description: The field from which to return significant text. allOf: - $ref: '#/components/schemas/_types.Field' filter_duplicate_text: description: Whether to out duplicate text to deal with noisy data. type: boolean gnd: description: Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. allOf: - $ref: '#/components/schemas/_types.aggregations.GoogleNormalizedDistanceHeuristic' include: description: Values to include. allOf: - $ref: '#/components/schemas/_types.aggregations.TermsInclude' jlh: description: Use JLH score as the significance score. allOf: - $ref: '#/components/schemas/_types.EmptyObject' min_doc_count: description: Only return values that are found in more than `min_doc_count` hits. default: 3.0 type: number mutual_information: description: Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. allOf: - $ref: '#/components/schemas/_types.aggregations.MutualInformationHeuristic' percentage: description: A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. allOf: - $ref: '#/components/schemas/_types.aggregations.PercentageScoreHeuristic' script_heuristic: description: Customized score, implemented via a script. allOf: - $ref: '#/components/schemas/_types.aggregations.ScriptedHeuristic' shard_min_doc_count: description: 'Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count. Values will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`.' type: number shard_size: description: 'The number of candidate terms produced by each shard. By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter.' type: number size: description: The number of buckets returned out of the overall terms list. type: number source_fields: description: Overrides the JSON `_source` fields from which text will be analyzed. allOf: - $ref: '#/components/schemas/_types.Fields' _types.aggregations.SignificantTermsAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: background_filter: description: A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' chi_square: description: Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. allOf: - $ref: '#/components/schemas/_types.aggregations.ChiSquareHeuristic' exclude: description: Terms to exclude. allOf: - $ref: '#/components/schemas/_types.aggregations.TermsExclude' execution_hint: description: 'Mechanism by which the aggregation should be executed: using field values directly or using global ordinals.' allOf: - $ref: '#/components/schemas/_types.aggregations.TermsAggregationExecutionHint' field: description: The field from which to return significant terms. allOf: - $ref: '#/components/schemas/_types.Field' gnd: description: Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. allOf: - $ref: '#/components/schemas/_types.aggregations.GoogleNormalizedDistanceHeuristic' include: description: Terms to include. allOf: - $ref: '#/components/schemas/_types.aggregations.TermsInclude' jlh: description: Use JLH score as the significance score. allOf: - $ref: '#/components/schemas/_types.EmptyObject' min_doc_count: description: Only return terms that are found in more than `min_doc_count` hits. default: 3.0 type: number mutual_information: description: Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. allOf: - $ref: '#/components/schemas/_types.aggregations.MutualInformationHeuristic' percentage: description: A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. allOf: - $ref: '#/components/schemas/_types.aggregations.PercentageScoreHeuristic' script_heuristic: description: Customized score, implemented via a script. allOf: - $ref: '#/components/schemas/_types.aggregations.ScriptedHeuristic' p_value: description: 'Significant terms heuristic that calculates the p-value between the term existing in foreground and background sets. The p-value is the probability of obtaining test results at least as extreme as the results actually observed, under the assumption that the null hypothesis is correct. The p-value is calculated assuming that the foreground set and the background set are independent https://en.wikipedia.org/wiki/Bernoulli_trial, with the null hypothesis that the probabilities are the same.' allOf: - $ref: '#/components/schemas/_types.aggregations.PValueHeuristic' shard_min_doc_count: description: 'Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`. Terms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`.' type: number shard_size: description: 'Can be used to control the volumes of candidate terms produced by each shard. By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter.' type: number size: description: The number of buckets returned out of the overall terms list. type: number indices._types.IndexSettingsUnassigned: type: object properties: node_left: allOf: - $ref: '#/components/schemas/indices._types.IndexSettingsUnassignedNodeLeft' _types.mapping.BinaryProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: type: type: string enum: - binary required: - type _types.mapping.AggregateMetricDoubleProperty: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: type: type: string enum: - aggregate_metric_double default_metric: type: string ignore_malformed: type: boolean metrics: type: array items: type: string time_series_metric: allOf: - $ref: '#/components/schemas/_types.mapping.TimeSeriesMetricType' required: - type - default_metric - metrics _types.query_dsl.DistanceFeatureQueryBaseGeoLocationDistance: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: origin: description: 'Date or point of origin used to calculate distances. If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date. Date Math, such as `now-1h`, is supported. If the field value is a `geo_point` field, the `origin` value must be a geopoint.' allOf: - $ref: '#/components/schemas/_types.GeoLocation' pivot: description: 'Distance from the `origin` at which relevance scores receive half of the `boost` value. If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`.' allOf: - $ref: '#/components/schemas/_types.Distance' field: description: 'Name of the field used to calculate distances. This field must meet the following criteria: be a `date`, `date_nanos` or `geo_point` field; have an `index` mapping parameter value of `true`, which is the default; have an `doc_values` mapping parameter value of `true`, which is the default.' allOf: - $ref: '#/components/schemas/_types.Field' required: - origin - pivot - field _types.query_dsl.MultiValueMode: type: string enum: - min - max - avg - sum indices._types.SettingsSimilarityBoolean: type: object properties: type: type: string enum: - boolean required: - type _types.WarmerStats: type: object properties: current: type: number total: type: number total_time: allOf: - $ref: '#/components/schemas/_types.Duration' total_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' required: - current - total - total_time_in_millis _types.Sort: oneOf: - $ref: '#/components/schemas/_types.SortCombinations' - type: array items: $ref: '#/components/schemas/_types.SortCombinations' _types.aggregations.GoogleNormalizedDistanceHeuristic: type: object properties: background_is_superset: description: Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. type: boolean _types.query_dsl.TermsSetQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: minimum_should_match: description: Specification describing number of matching terms required to return a document. x-state: Generally available; Added in 8.10.0 allOf: - $ref: '#/components/schemas/_types.MinimumShouldMatch' minimum_should_match_field: description: Numeric field containing the number of matching terms required to return a document. allOf: - $ref: '#/components/schemas/_types.Field' minimum_should_match_script: description: Custom script containing the number of matching terms required to return a document. allOf: - $ref: '#/components/schemas/_types.Script' terms: description: Array of terms you wish to find in the provided field. type: array items: $ref: '#/components/schemas/_types.FieldValue' required: - terms _types.aggregations.TermsAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: collect_mode: description: 'Determines how child aggregations should be calculated: breadth-first or depth-first.' allOf: - $ref: '#/components/schemas/_types.aggregations.TermsAggregationCollectMode' exclude: description: 'Values to exclude. Accepts regular expressions and partitions.' allOf: - $ref: '#/components/schemas/_types.aggregations.TermsExclude' execution_hint: description: Determines whether the aggregation will use field values directly or global ordinals. allOf: - $ref: '#/components/schemas/_types.aggregations.TermsAggregationExecutionHint' field: description: The field from which to return terms. allOf: - $ref: '#/components/schemas/_types.Field' include: description: 'Values to include. Accepts regular expressions and partitions.' allOf: - $ref: '#/components/schemas/_types.aggregations.TermsInclude' min_doc_count: description: Only return values that are found in more than `min_doc_count` hits. default: 1.0 type: number missing: description: 'The value to apply to documents that do not have a value. By default, documents without a value are ignored.' allOf: - $ref: '#/components/schemas/_types.aggregations.Missing' missing_order: allOf: - $ref: '#/components/schemas/_types.aggregations.MissingOrder' missing_bucket: type: boolean value_type: description: Coerced unmapped fields into the specified type. type: string order: description: 'Specifies the sort order of the buckets. Defaults to sorting by descending document count.' allOf: - $ref: '#/components/schemas/_types.aggregations.AggregateOrder' script: allOf: - $ref: '#/components/schemas/_types.Script' shard_min_doc_count: description: 'Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`. Terms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`.' type: number shard_size: description: 'The number of candidate terms produced by each shard. By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter.' type: number show_term_doc_count_error: description: Set to `true` to return the `doc_count_error_upper_bound`, which is an upper bound to the error on the `doc_count` returned by each shard. type: boolean size: description: The number of buckets returned out of the overall terms list. default: 10.0 type: number format: type: string _types.analysis.IcuCollationAlternate: type: string enum: - shifted - non-ignorable _types.analysis.IcuNormalizationMode: type: string enum: - decompose - compose _types.query_dsl.ConstantScoreQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: filter: description: 'Filter query you wish to run. Any returned documents must match this query. Filter queries do not calculate relevance scores. To speed up performance, Elasticsearch automatically caches frequently used filter queries.' allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' required: - filter _types.query_dsl.DateRangeQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.RangeQueryBaseDateMath' - type: object properties: format: description: Date format used to convert `date` values in the query. allOf: - $ref: '#/components/schemas/_types.DateFormat' time_zone: description: Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC. allOf: - $ref: '#/components/schemas/_types.TimeZone' _types.WaitForActiveShardOptions: type: string enum: - all - index-setting _types.Indices: oneOf: - $ref: '#/components/schemas/_types.IndexName' - type: array items: $ref: '#/components/schemas/_types.IndexName' _types.query_dsl.MatchPhraseQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: analyzer: description: Analyzer used to convert the text in the query value into tokens. type: string query: description: Query terms that are analyzed and turned into a phrase query. type: string slop: description: Maximum number of positions allowed between matching tokens. default: 0.0 type: number zero_terms_query: description: Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. default: '''none''' allOf: - $ref: '#/components/schemas/_types.query_dsl.ZeroTermsQuery' required: - query _types.query_dsl.FunctionBoostMode: type: string enum: - multiply - replace - sum - avg - max - min indices._types.IndexRoutingRebalanceOptions: type: string enum: - all - primaries - replicas - none _types.query_dsl.DateDecayFunction: allOf: - $ref: '#/components/schemas/_types.query_dsl.DecayFunctionBaseDateMathDuration' - type: object _types.query_dsl.DecayFunctionBasedoubledouble: type: object properties: multi_value_mode: description: Determines how the distance is calculated when a field used for computing the decay contains multiple values. default: min allOf: - $ref: '#/components/schemas/_types.query_dsl.MultiValueMode' _types.analysis.TokenChar: type: string enum: - letter - digit - whitespace - punctuation - symbol - custom _types.query_dsl.HasParentQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: ignore_unmapped: description: 'Indicates whether to ignore an unmapped `parent_type` and not return any documents instead of an error. You can use this parameter to query multiple indices that may not contain the `parent_type`.' default: false type: boolean inner_hits: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-inner-hits description: If defined, each search hit will contain inner hits. allOf: - $ref: '#/components/schemas/_global.search._types.InnerHits' parent_type: description: Name of the parent relationship mapped for the `join` field. allOf: - $ref: '#/components/schemas/_types.RelationName' query: description: 'Query you wish to run on parent documents of the `parent_type` field. If a parent document matches the search, the query returns its child documents.' allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' score: description: Indicates whether the relevance score of a matching parent document is aggregated into its child documents. default: false type: boolean required: - parent_type - query _types.query_dsl.SpanMultiTermQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: match: description: Should be a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query). allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' required: - match _types.SortOrder: type: string enum: - asc - desc _types.mapping.CountedKeywordProperty: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: type: type: string enum: - counted_keyword index: type: boolean required: - type _types.analysis.MappingCharFilter: allOf: - $ref: '#/components/schemas/_types.analysis.CharFilterBase' - type: object properties: type: type: string enum: - mapping mappings: type: array items: type: string mappings_path: type: string required: - type _types.analysis.IndonesianAnalyzer: type: object properties: type: type: string enum: - indonesian stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type _types.analysis.CharFilterBase: type: object properties: version: allOf: - $ref: '#/components/schemas/_types.VersionString' _types.analysis.IrishAnalyzer: type: object properties: type: type: string enum: - irish stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type _types.query_dsl.RankFeatureQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: field: description: '`rank_feature` or `rank_features` field used to boost relevance scores.' allOf: - $ref: '#/components/schemas/_types.Field' saturation: description: Saturation function used to boost relevance scores based on the value of the rank feature `field`. allOf: - $ref: '#/components/schemas/_types.query_dsl.RankFeatureFunctionSaturation' log: description: Logarithmic function used to boost relevance scores based on the value of the rank feature `field`. allOf: - $ref: '#/components/schemas/_types.query_dsl.RankFeatureFunctionLogarithm' linear: description: Linear function used to boost relevance scores based on the value of the rank feature `field`. allOf: - $ref: '#/components/schemas/_types.query_dsl.RankFeatureFunctionLinear' sigmoid: description: Sigmoid function used to boost relevance scores based on the value of the rank feature `field`. allOf: - $ref: '#/components/schemas/_types.query_dsl.RankFeatureFunctionSigmoid' required: - field _types.analysis.PortugueseAnalyzer: type: object properties: type: type: string enum: - portuguese stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type _types.aggregations.HoltMovingAverageAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MovingAverageAggregationBase' - type: object properties: model: type: string enum: - holt settings: allOf: - $ref: '#/components/schemas/_types.aggregations.HoltLinearModelSettings' required: - model - settings indices._types.Storage: type: object properties: type: allOf: - $ref: '#/components/schemas/indices._types.StorageType' allow_mmap: description: 'You can restrict the use of the mmapfs and the related hybridfs store type via the setting node.store.allow_mmap. This is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This setting is useful, for example, if you are in an environment where you can not control the ability to create a lot of memory maps so you need disable the ability to use memory-mapping.' type: boolean stats_refresh_interval: description: How often store statistics are refreshed allOf: - $ref: '#/components/schemas/_types.Duration' required: - type _types.analysis.DelimitedPayloadTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - delimited_payload delimiter: description: Character used to separate tokens from payloads. Defaults to `|`. type: string encoding: description: Data type for the stored payload. allOf: - $ref: '#/components/schemas/_types.analysis.DelimitedPayloadEncoding' required: - type _types.analysis.SynonymTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.SynonymTokenFilterBase' - type: object properties: type: type: string enum: - synonym required: - type _types.query_dsl.SpanFirstQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: end: description: Controls the maximum end position permitted in a match. type: number match: description: Can be any other span type query. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanQuery' required: - end - match indices._types.Queries: type: object properties: cache: allOf: - $ref: '#/components/schemas/indices._types.CacheQueries' _types.query_dsl.MatchBoolPrefixQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: analyzer: description: Analyzer used to convert the text in the query value into tokens. type: string fuzziness: description: 'Maximum edit distance allowed for matching. Can be applied to the term subqueries constructed for all terms but the final term.' allOf: - $ref: '#/components/schemas/_types.Fuzziness' fuzzy_rewrite: description: 'Method used to rewrite the query. Can be applied to the term subqueries constructed for all terms but the final term.' allOf: - $ref: '#/components/schemas/_types.MultiTermQueryRewrite' fuzzy_transpositions: description: 'If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). Can be applied to the term subqueries constructed for all terms but the final term.' default: true type: boolean max_expansions: description: 'Maximum number of terms to which the query will expand. Can be applied to the term subqueries constructed for all terms but the final term.' default: 50.0 type: number minimum_should_match: description: 'Minimum number of clauses that must match for a document to be returned. Applied to the constructed bool query.' allOf: - $ref: '#/components/schemas/_types.MinimumShouldMatch' operator: description: 'Boolean logic used to interpret text in the query value. Applied to the constructed bool query.' default: '''or''' allOf: - $ref: '#/components/schemas/_types.query_dsl.Operator' prefix_length: description: 'Number of beginning characters left unchanged for fuzzy matching. Can be applied to the term subqueries constructed for all terms but the final term.' default: 0.0 type: number query: description: 'Terms you wish to find in the provided field. The last term is used in a prefix query.' type: string required: - query _types.RuleRetriever: allOf: - $ref: '#/components/schemas/_types.RetrieverBase' - type: object properties: ruleset_ids: description: The ruleset IDs containing the rules this retriever is evaluating against. oneOf: - $ref: '#/components/schemas/_types.Id' - type: array items: $ref: '#/components/schemas/_types.Id' match_criteria: description: The match criteria that will determine if a rule in the provided rulesets should be applied. type: object retriever: description: The retriever whose results rules should be applied to. allOf: - $ref: '#/components/schemas/_types.RetrieverContainer' rank_window_size: description: This value determines the size of the individual result set. type: number required: - ruleset_ids - match_criteria - retriever _types.analysis.DutchStemTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - dutch_stem required: - type _types.analysis.FinnishAnalyzer: type: object properties: type: type: string enum: - finnish stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type indices._types.IndexingSlowlogTresholds: type: object properties: index: description: 'The indexing slow log, similar in functionality to the search slow log. The log file name ends with `_index_indexing_slowlog.json`. Log and the thresholds are configured in the same way as the search slowlog.' allOf: - $ref: '#/components/schemas/indices._types.SlowlogTresholdLevels' _types.analysis.StopWordLanguage: type: string enum: - _arabic_ - _armenian_ - _basque_ - _bengali_ - _brazilian_ - _bulgarian_ - _catalan_ - _cjk_ - _czech_ - _danish_ - _dutch_ - _english_ - _estonian_ - _finnish_ - _french_ - _galician_ - _german_ - _greek_ - _hindi_ - _hungarian_ - _indonesian_ - _irish_ - _italian_ - _latvian_ - _lithuanian_ - _norwegian_ - _persian_ - _portuguese_ - _romanian_ - _russian_ - _serbian_ - _sorani_ - _spanish_ - _swedish_ - _thai_ - _turkish_ - _none_ _types.query_dsl.FieldValueFactorModifier: type: string enum: - none - log - log1p - log2p - ln - ln1p - ln2p - square - sqrt - reciprocal _types.GeoHashPrecision: description: A precision that can be expressed as a geohash length between 1 and 12, or a distance measure like "1km", "10m". oneOf: - type: number - type: string _types.analysis.FingerprintTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - fingerprint max_output_size: description: Maximum character length, including whitespace, of the output token. Defaults to `255`. Concatenated tokens longer than this will result in no token output. type: number separator: description: Character to use to concatenate the token stream input. Defaults to a space. type: string required: - type _types.analysis.LetterTokenizer: allOf: - $ref: '#/components/schemas/_types.analysis.TokenizerBase' - type: object properties: type: type: string enum: - letter required: - type _types.mapping.RankVectorElementType: type: string enum: - byte - float - bit _types.Fields: oneOf: - $ref: '#/components/schemas/_types.Field' - type: array items: $ref: '#/components/schemas/_types.Field' _types.ulong: type: number _types.mapping.CompletionProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: analyzer: type: string contexts: type: array items: $ref: '#/components/schemas/_types.mapping.SuggestContext' max_input_length: type: number preserve_position_increments: type: boolean preserve_separators: type: boolean search_analyzer: type: string type: type: string enum: - completion required: - type _types.mapping.JoinProperty: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: relations: type: object additionalProperties: oneOf: - $ref: '#/components/schemas/_types.RelationName' - type: array items: $ref: '#/components/schemas/_types.RelationName' eager_global_ordinals: type: boolean type: type: string enum: - join required: - type _types.analysis.IcuTransformDirection: type: string enum: - forward - reverse _spec_utils.Stringifiedboolean: description: 'Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.' oneOf: - type: boolean - type: string _global.search._types.ScoreMode: type: string enum: - avg - max - min - multiply - total _types.aggregations.PercentageScoreHeuristic: type: object _types.query_dsl.SpanNearQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: clauses: description: Array of one or more other span type queries. type: array items: $ref: '#/components/schemas/_types.query_dsl.SpanQuery' in_order: description: Controls whether matches are required to be in-order. type: boolean slop: description: Controls the maximum number of intervening unmatched positions permitted. type: number required: - clauses _types.mapping.SyntheticSourceKeepEnum: type: string enum: - none - arrays - all _types.mapping.PointProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: ignore_malformed: type: boolean ignore_z_value: type: boolean null_value: type: string type: type: string enum: - point required: - type _types.mapping.GeoPointMetricType: type: string enum: - gauge - counter - position indices.recovery.TranslogStatus: type: object properties: percent: allOf: - $ref: '#/components/schemas/_types.Percentage' recovered: type: number total: type: number total_on_start: type: number total_time: allOf: - $ref: '#/components/schemas/_types.Duration' total_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' required: - percent - recovered - total - total_on_start - total_time_in_millis _types.analysis.StopTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - stop ignore_case: description: If `true`, stop word matching is case insensitive. For example, if `true`, a stop word of the matches and removes `The`, `THE`, or `the`. Defaults to `false`. type: boolean remove_trailing: description: If `true`, the last token of a stream is removed if it’s a stop word. Defaults to `true`. type: boolean stopwords: description: Language value, such as `_arabic_` or `_thai_`. Defaults to `_english_`. allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: description: 'Path to a file that contains a list of stop words to remove. This path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each stop word in the file must be separated by a line break.' type: string required: - type _types.analysis.PatternAnalyzer: type: object properties: type: type: string enum: - pattern version: deprecated: true allOf: - $ref: '#/components/schemas/_types.VersionString' flags: description: Java regular expression flags. Flags should be pipe-separated, eg "CASE_INSENSITIVE|COMMENTS". type: string lowercase: description: 'Should terms be lowercased or not. Defaults to `true`.' default: true type: boolean pattern: description: 'A Java regular expression. Defaults to `\W+`.' default: \W+ type: string stopwords: description: 'A pre-defined stop words list like `_english_` or an array containing a list of stop words. Defaults to `_none_`.' default: _none_ allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: description: The path to a file containing stop words. type: string required: - type _types.analysis.ThaiTokenizer: allOf: - $ref: '#/components/schemas/_types.analysis.TokenizerBase' - type: object properties: type: type: string enum: - thai required: - type indices._types.RetentionSource: type: string enum: - data_stream_configuration - default_global_retention - max_global_retention - default_failures_retention _types.aggregations.MutualInformationHeuristic: type: object properties: background_is_superset: description: Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. type: boolean include_negatives: description: Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset. type: boolean _types.query_dsl.IntervalsFuzzy: type: object properties: analyzer: description: Analyzer used to normalize the term. type: string fuzziness: description: Maximum edit distance allowed for matching. default: auto allOf: - $ref: '#/components/schemas/_types.Fuzziness' prefix_length: description: Number of beginning characters left unchanged when creating expansions. default: 0.0 type: number term: description: The term to match. type: string transpositions: description: Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`). default: true type: boolean use_field: description: 'If specified, match intervals from this field rather than the top-level field. The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.' allOf: - $ref: '#/components/schemas/_types.Field' required: - term indices.recovery.RecoveryIndexStatus: type: object properties: bytes: allOf: - $ref: '#/components/schemas/indices.recovery.RecoveryBytes' files: allOf: - $ref: '#/components/schemas/indices.recovery.RecoveryFiles' size: allOf: - $ref: '#/components/schemas/indices.recovery.RecoveryBytes' source_throttle_time: allOf: - $ref: '#/components/schemas/_types.Duration' source_throttle_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' target_throttle_time: allOf: - $ref: '#/components/schemas/_types.Duration' target_throttle_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' total_time: allOf: - $ref: '#/components/schemas/_types.Duration' total_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' required: - files - size - source_throttle_time_in_millis - target_throttle_time_in_millis - total_time_in_millis _types.analysis.IcuFoldingTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - icu_folding unicode_set_filter: type: string required: - type - unicode_set_filter _types.aggregations.GeoLineAggregation: type: object properties: point: description: The name of the geo_point field. allOf: - $ref: '#/components/schemas/_types.aggregations.GeoLinePoint' sort: description: 'The name of the numeric field to use as the sort key for ordering the points. When the `geo_line` aggregation is nested inside a `time_series` aggregation, this field defaults to `@timestamp`, and any other value will result in error.' allOf: - $ref: '#/components/schemas/_types.aggregations.GeoLineSort' include_sort: description: When `true`, returns an additional array of the sort values in the feature properties. type: boolean sort_order: description: The order in which the line is sorted (ascending or descending). default: asc allOf: - $ref: '#/components/schemas/_types.SortOrder' size: description: 'The maximum length of the line represented in the aggregation. Valid sizes are between 1 and 10000.' default: 10000.0 type: number required: - point _types.analysis.PatternReplaceCharFilter: allOf: - $ref: '#/components/schemas/_types.analysis.CharFilterBase' - type: object properties: type: type: string enum: - pattern_replace flags: type: string pattern: type: string replacement: type: string required: - type - pattern _types.analysis.HtmlStripCharFilter: allOf: - $ref: '#/components/schemas/_types.analysis.CharFilterBase' - type: object properties: type: type: string enum: - html_strip escaped_tags: type: array items: type: string required: - type indices.stats.ShardLease: type: object properties: id: allOf: - $ref: '#/components/schemas/_types.Id' retaining_seq_no: allOf: - $ref: '#/components/schemas/_types.SequenceNumber' timestamp: type: number source: type: string required: - id - retaining_seq_no - timestamp - source indices.forcemerge._types.ForceMergeResponseBody: allOf: - $ref: '#/components/schemas/_types.ShardsOperationResponseBase' - type: object properties: task: description: 'task contains a task id returned when wait_for_completion=false, you can use the task_id to get the status of the task at _tasks/' type: string _types.PinnedRetriever: allOf: - $ref: '#/components/schemas/_types.RetrieverBase' - type: object properties: retriever: description: Inner retriever. allOf: - $ref: '#/components/schemas/_types.RetrieverContainer' ids: type: array items: type: string docs: type: array items: $ref: '#/components/schemas/_types.SpecifiedDocument' rank_window_size: type: number required: - retriever _types.RRFRetrieverComponent: description: Wraps a retriever with an optional weight for RRF scoring. type: object properties: retriever: description: The nested retriever configuration. allOf: - $ref: '#/components/schemas/_types.RetrieverContainer' weight: description: Weight multiplier for this retriever's contribution to the RRF score. Higher values increase influence. Defaults to 1.0 if not specified. Must be non-negative. default: 1.0 type: number required: - retriever _types.analysis.PhoneticEncoder: type: string enum: - metaphone - double_metaphone - soundex - refined_soundex - caverphone1 - caverphone2 - cologne - nysiis - koelnerphonetik - haasephonetik - beider_morse - daitch_mokotoff _types.analysis.DutchAnalyzer: type: object properties: type: type: string enum: - dutch stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type indices._types.SettingsSimilarityScripted: type: object properties: type: type: string enum: - scripted script: allOf: - $ref: '#/components/schemas/_types.Script' weight_script: allOf: - $ref: '#/components/schemas/_types.Script' required: - type - script indices._types.IndexSettingsLifecycleStep: type: object properties: wait_time_threshold: description: 'Time to wait for the cluster to resolve allocation issues during an ILM shrink action. Must be greater than 1h (1 hour). See Shard allocation for shrink.' allOf: - $ref: '#/components/schemas/_types.Duration' _types.ScriptField: type: object properties: script: allOf: - $ref: '#/components/schemas/_types.Script' ignore_failure: type: boolean required: - script _types.analysis.SnowballAnalyzer: type: object properties: type: type: string enum: - snowball version: deprecated: true allOf: - $ref: '#/components/schemas/_types.VersionString' language: allOf: - $ref: '#/components/schemas/_types.analysis.SnowballLanguage' stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' required: - type - language _types.analysis.SoraniNormalizationTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - sorani_normalization required: - type _types.mapping.DateNanosProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: boost: type: number format: type: string ignore_malformed: type: boolean index: type: boolean script: allOf: - $ref: '#/components/schemas/_types.Script' on_script_error: allOf: - $ref: '#/components/schemas/_types.mapping.OnScriptError' null_value: allOf: - $ref: '#/components/schemas/_types.DateTime' precision_step: type: number type: type: string enum: - date_nanos required: - type _types.analysis.FrenchAnalyzer: type: object properties: type: type: string enum: - french stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type _types.aggregations.EwmaMovingAverageAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MovingAverageAggregationBase' - type: object properties: model: type: string enum: - ewma settings: allOf: - $ref: '#/components/schemas/_types.aggregations.EwmaModelSettings' required: - model - settings _types.query_dsl.CombinedFieldsOperator: type: string enum: - or - and _types.aggregations.AutoDateHistogramAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: buckets: description: The target number of buckets. default: 10.0 type: number field: description: The field on which to run the aggregation. allOf: - $ref: '#/components/schemas/_types.Field' format: description: 'The date format used to format `key_as_string` in the response. If no `format` is specified, the first date format specified in the field mapping is used.' type: string minimum_interval: description: 'The minimum rounding interval. This can make the collection process more efficient, as the aggregation will not attempt to round at any interval lower than `minimum_interval`.' oneOf: - $ref: '#/components/schemas/_types.aggregations.MinimumInterval' - type: - string - 'null' missing: description: 'The value to apply to documents that do not have a value. By default, documents without a value are ignored.' allOf: - $ref: '#/components/schemas/_types.DateTime' offset: description: Time zone specified as a ISO 8601 UTC offset. type: string params: type: object additionalProperties: type: object script: allOf: - $ref: '#/components/schemas/_types.Script' time_zone: description: Time zone ID. allOf: - $ref: '#/components/schemas/_types.TimeZone' _types.analysis.ThaiAnalyzer: type: object properties: type: type: string enum: - thai stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string required: - type _types.aggregations.PercentileRanksAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase' - type: object properties: keyed: description: 'By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array. Set to `false` to disable this behavior.' default: true type: boolean values: description: An array of values for which to calculate the percentile ranks. oneOf: - type: array items: type: number - type: - string - 'null' hdr: description: Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks. allOf: - $ref: '#/components/schemas/_types.aggregations.HdrMethod' tdigest: description: Sets parameters for the default TDigest algorithm used to calculate percentile ranks. allOf: - $ref: '#/components/schemas/_types.aggregations.TDigest' _types.query_dsl.Operator: type: string enum: - and - AND - or - OR _types.query_dsl.RuleQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: organic: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' ruleset_ids: oneOf: - $ref: '#/components/schemas/_types.Id' - type: array items: $ref: '#/components/schemas/_types.Id' ruleset_id: type: string match_criteria: type: object required: - organic - match_criteria indices.stats.IndexStats: type: object properties: completion: description: Contains statistics about completions across all shards assigned to the node. allOf: - $ref: '#/components/schemas/_types.CompletionStats' docs: description: Contains statistics about documents across all primary shards assigned to the node. allOf: - $ref: '#/components/schemas/_types.DocStats' fielddata: description: Contains statistics about the field data cache across all shards assigned to the node. allOf: - $ref: '#/components/schemas/_types.FielddataStats' flush: description: Contains statistics about flush operations for the node. allOf: - $ref: '#/components/schemas/_types.FlushStats' get: description: Contains statistics about get operations for the node. allOf: - $ref: '#/components/schemas/_types.GetStats' indexing: description: Contains statistics about indexing operations for the node. allOf: - $ref: '#/components/schemas/_types.IndexingStats' indices: description: Contains statistics about indices operations for the node. allOf: - $ref: '#/components/schemas/indices.stats.IndicesStats' merges: description: Contains statistics about merge operations for the node. allOf: - $ref: '#/components/schemas/_types.MergesStats' query_cache: description: Contains statistics about the query cache across all shards assigned to the node. allOf: - $ref: '#/components/schemas/_types.QueryCacheStats' recovery: description: Contains statistics about recovery operations for the node. allOf: - $ref: '#/components/schemas/_types.RecoveryStats' refresh: description: Contains statistics about refresh operations for the node. allOf: - $ref: '#/components/schemas/_types.RefreshStats' request_cache: description: Contains statistics about the request cache across all shards assigned to the node. allOf: - $ref: '#/components/schemas/_types.RequestCacheStats' search: description: Contains statistics about search operations for the node. allOf: - $ref: '#/components/schemas/_types.SearchStats' segments: description: Contains statistics about segments across all shards assigned to the node. allOf: - $ref: '#/components/schemas/_types.SegmentsStats' store: description: Contains statistics about the size of shards assigned to the node. allOf: - $ref: '#/components/schemas/_types.StoreStats' translog: description: Contains statistics about transaction log operations for the node. allOf: - $ref: '#/components/schemas/_types.TranslogStats' warmer: description: Contains statistics about index warming operations for the node. allOf: - $ref: '#/components/schemas/_types.WarmerStats' bulk: allOf: - $ref: '#/components/schemas/_types.BulkStats' shard_stats: x-state: Generally available; Added in 7.15.0 allOf: - $ref: '#/components/schemas/indices.stats.ShardsTotalStats' _types.mapping.DenseVectorIndexOptionsType: type: string enum: - bbq_flat - bbq_hnsw - bbq_disk - flat - hnsw - int4_flat - int4_hnsw - int8_flat - int8_hnsw indices._types.MappingLimitSettingsSourceFields: type: object properties: mode: allOf: - $ref: '#/components/schemas/indices._types.SourceMode' required: - mode _types.analysis.HindiAnalyzer: type: object properties: type: type: string enum: - hindi stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type ml._types.ClassificationInferenceOptions: type: object properties: num_top_classes: description: Specifies the number of top class predictions to return. Defaults to 0. type: number num_top_feature_importance_values: description: Specifies the maximum number of feature importance values per document. default: 0.0 type: number prediction_field_type: description: 'Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false.' type: string results_field: description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. type: string top_classes_results_field: description: Specifies the field to which the top classes are written. Defaults to top_classes. type: string _types.query_dsl.RankFeatureFunctionLinear: allOf: - $ref: '#/components/schemas/_types.query_dsl.RankFeatureFunction' - type: object _types.RrfRank: allOf: - $ref: '#/components/schemas/_types.RankBase' - type: object properties: rank_constant: description: How much influence documents in individual result sets per query have over the final ranked result set type: number rank_window_size: description: Size of the individual result sets per query type: number _types.aggregations.PipelineAggregationBase: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketPathAggregation' - type: object properties: format: description: '`DecimalFormat` pattern for the output value. If specified, the formatted value is returned in the aggregation’s `value_as_string` property.' type: string gap_policy: description: Policy to apply when gaps are found in the data. default: skip allOf: - $ref: '#/components/schemas/_types.aggregations.GapPolicy' _types.analysis.ApostropheTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - apostrophe required: - type _types.KnnSearch: type: object properties: field: description: The name of the vector field to search against allOf: - $ref: '#/components/schemas/_types.Field' query_vector: description: The query vector allOf: - $ref: '#/components/schemas/_types.QueryVector' query_vector_builder: description: The query vector builder. You must provide a query_vector_builder or query_vector, but not both. allOf: - $ref: '#/components/schemas/_types.QueryVectorBuilder' k: description: The final number of nearest neighbors to return as top hits type: number num_candidates: description: The number of nearest neighbor candidates to consider per shard type: number visit_percentage: description: The percentage of vectors to explore per shard while doing knn search with bbq_disk x-state: Generally available; Added in 9.2.0 type: number boost: description: Boost value to apply to kNN scores type: number filter: description: Filters for the kNN search query oneOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' - type: array items: $ref: '#/components/schemas/_types.query_dsl.QueryContainer' similarity: description: The minimum similarity for a vector to be considered a match type: number inner_hits: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-inner-hits description: If defined, each search hit will contain inner hits. allOf: - $ref: '#/components/schemas/_global.search._types.InnerHits' rescore_vector: description: Apply oversampling and rescoring to quantized vectors x-state: Generally available; Added in 8.18.0 allOf: - $ref: '#/components/schemas/_types.RescoreVector' _name: type: string required: - field _types.query_dsl.FunctionScoreQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: boost_mode: description: Defines how he newly computed score is combined with the score of the query default: multiply allOf: - $ref: '#/components/schemas/_types.query_dsl.FunctionBoostMode' functions: description: One or more functions that compute a new score for each document returned by the query. type: array items: $ref: '#/components/schemas/_types.query_dsl.FunctionScoreContainer' max_boost: description: Restricts the new score to not exceed the provided limit. type: number min_score: description: Excludes documents that do not meet the provided score threshold. type: number query: description: A query that determines the documents for which a new score is computed. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' score_mode: description: Specifies how the computed scores are combined default: multiply allOf: - $ref: '#/components/schemas/_types.query_dsl.FunctionScoreMode' _types.analysis.BasqueAnalyzer: type: object properties: type: type: string enum: - basque stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type indices._types.SlowlogTresholds: type: object properties: query: allOf: - $ref: '#/components/schemas/indices._types.SlowlogTresholdLevels' fetch: allOf: - $ref: '#/components/schemas/indices._types.SlowlogTresholdLevels' indices.analyze.AnalyzerDetail: type: object properties: name: type: string tokens: type: array items: $ref: '#/components/schemas/indices.analyze.ExplainAnalyzeToken' required: - name - tokens _types.analysis.EstonianAnalyzer: type: object properties: type: type: string enum: - estonian stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string required: - type indices.stats.MappingStats: type: object properties: total_count: type: number total_estimated_overhead: allOf: - $ref: '#/components/schemas/_types.ByteSize' total_estimated_overhead_in_bytes: type: number total_segments: type: number total_segment_fields: type: number average_fields_per_segment: type: number required: - total_count - total_estimated_overhead_in_bytes - total_segments - total_segment_fields - average_fields_per_segment indices.recovery.RecoveryStatus: type: object properties: shards: type: array items: $ref: '#/components/schemas/indices.recovery.ShardRecovery' required: - shards _types.mapping.CompositeSubField: type: object properties: type: allOf: - $ref: '#/components/schemas/_types.mapping.RuntimeFieldType' required: - type _types.analysis.LatvianAnalyzer: type: object properties: type: type: string enum: - latvian stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type _types.query_dsl.GeoShapeQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: ignore_unmapped: description: 'Set to `true` to ignore an unmapped field and not match any documents for this query. Set to `false` to throw an exception if the field is not mapped.' default: false type: boolean _types.mapping.RankFeatureProperty: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: positive_score_impact: type: boolean type: type: string enum: - rank_feature required: - type _types.analysis.SynonymGraphTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.SynonymTokenFilterBase' - type: object properties: type: type: string enum: - synonym_graph required: - type _types.mapping.SparseVectorProperty: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: store: type: boolean type: type: string enum: - sparse_vector index_options: description: 'Additional index options for the sparse vector field that controls the token pruning behavior of the sparse vector field.' x-state: Generally available; Added in 8.19.0 allOf: - $ref: '#/components/schemas/_types.mapping.SparseVectorIndexOptions' required: - type indices._types.SearchIdle: type: object properties: after: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' _types.CommonStatsFlag: type: string enum: - _all - store - indexing - get - search - merge - flush - refresh - query_cache - fielddata - docs - warmer - completion - segments - translog - request_cache - recovery - bulk - shard_stats - mappings - dense_vector - sparse_vector cluster._types.ComponentTemplateNodeWithRollover: type: object properties: template: allOf: - $ref: '#/components/schemas/cluster._types.ComponentTemplateSummaryRes' version: allOf: - $ref: '#/components/schemas/_types.VersionNumber' _meta: allOf: - $ref: '#/components/schemas/_types.Metadata' deprecated: type: boolean created_date: description: Date and time when the component template was created. Only returned if the `human` query parameter is `true`. x-state: Generally available; Added in 9.2.0 allOf: - $ref: '#/components/schemas/_types.DateTime' created_date_millis: description: Date and time when the component template was created, in milliseconds since the epoch. x-state: Generally available; Added in 9.2.0 allOf: - $ref: '#/components/schemas/_types.EpochTimeUnitMillis' modified_date: description: Date and time when the component template was last modified. Only returned if the `human` query parameter is `true`. x-state: Generally available; Added in 9.2.0 allOf: - $ref: '#/components/schemas/_types.DateTime' modified_date_millis: description: Date and time when the component template was last modified, in milliseconds since the epoch. x-state: Generally available; Added in 9.2.0 allOf: - $ref: '#/components/schemas/_types.EpochTimeUnitMillis' required: - template _types.aggregations.MovingFunctionAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object properties: script: description: The script that should be executed on each window of data. type: string shift: description: 'By default, the window consists of the last n values excluding the current bucket. Increasing `shift` by 1, moves the starting window position by 1 to the right.' default: 0.0 type: number window: description: The size of window to "slide" across the histogram. type: number _types.query_dsl.FieldAndFormat: description: A reference to a field with formatting instructions on how to return the value type: object properties: field: description: A wildcard pattern. The request returns values for field names matching this pattern. allOf: - $ref: '#/components/schemas/_types.Field' format: description: The format in which the values are returned. type: string include_unmapped: type: boolean required: - field _types.GeoHexCell: description: A map hex cell (H3) reference type: string indices._types.IndexSettingBlocks: type: object properties: read_only: allOf: - $ref: '#/components/schemas/_spec_utils.Stringifiedboolean' read_only_allow_delete: allOf: - $ref: '#/components/schemas/_spec_utils.Stringifiedboolean' read: allOf: - $ref: '#/components/schemas/_spec_utils.Stringifiedboolean' write: allOf: - $ref: '#/components/schemas/_spec_utils.Stringifiedboolean' metadata: allOf: - $ref: '#/components/schemas/_spec_utils.Stringifiedboolean' indices.field_usage_stats.FieldsUsageBody: type: object properties: _shards: allOf: - $ref: '#/components/schemas/_types.ShardStatistics' required: - _shards _types.aggregations.TopMetricsAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase' - type: object properties: metrics: description: The fields of the top document to return. oneOf: - $ref: '#/components/schemas/_types.aggregations.TopMetricsValue' - type: array items: $ref: '#/components/schemas/_types.aggregations.TopMetricsValue' size: description: The number of top documents from which to return metrics. default: 1.0 type: number sort: description: The sort order of the documents. allOf: - $ref: '#/components/schemas/_types.Sort' _types.RefreshStats: type: object properties: external_total: type: number external_total_time: allOf: - $ref: '#/components/schemas/_types.Duration' external_total_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' listeners: type: number total: type: number total_time: allOf: - $ref: '#/components/schemas/_types.Duration' total_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' required: - external_total - external_total_time_in_millis - listeners - total - total_time_in_millis _types.analysis.PatternCaptureTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - pattern_capture patterns: description: A list of regular expressions to match. type: array items: type: string preserve_original: description: If set to `true` (the default) it will emit the original token. allOf: - $ref: '#/components/schemas/_spec_utils.Stringifiedboolean' required: - type - patterns indices.resolve_index.ResolveIndexDataStreamsItem: type: object properties: name: allOf: - $ref: '#/components/schemas/_types.DataStreamName' timestamp_field: allOf: - $ref: '#/components/schemas/_types.Field' backing_indices: allOf: - $ref: '#/components/schemas/_types.Indices' required: - name - timestamp_field - backing_indices _types.GeoHashLocation: type: object properties: geohash: allOf: - $ref: '#/components/schemas/_types.GeoHash' required: - geohash _types.analysis.WordDelimiterTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.WordDelimiterTokenFilterBase' - type: object properties: type: type: string enum: - word_delimiter required: - type _types.SortOptions: type: object properties: _score: allOf: - $ref: '#/components/schemas/_types.ScoreSort' _doc: allOf: - $ref: '#/components/schemas/_types.ScoreSort' _geo_distance: allOf: - $ref: '#/components/schemas/_types.GeoDistanceSort' _script: allOf: - $ref: '#/components/schemas/_types.ScriptSort' minProperties: 1 maxProperties: 1 _types.aggregations.BoxplotAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase' - type: object properties: compression: description: Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. type: number execution_hint: description: 'The default implementation of TDigest is optimized for performance, scaling to millions or even billions of sample values while maintaining acceptable accuracy levels (close to 1% relative error for millions of samples in some cases). To use an implementation optimized for accuracy, set this parameter to high_accuracy instead.' default: default allOf: - $ref: '#/components/schemas/_types.aggregations.TDigestExecutionHint' indices._types.IndexSettings: type: object properties: index: allOf: - $ref: '#/components/schemas/indices._types.IndexSettings' mode: type: string routing_path: oneOf: - type: string - type: array items: type: string soft_deletes: allOf: - $ref: '#/components/schemas/indices._types.SoftDeletes' sort: allOf: - $ref: '#/components/schemas/indices._types.IndexSegmentSort' number_of_shards: default: '1' oneOf: - type: number - type: string number_of_replicas: default: '0' oneOf: - type: number - type: string number_of_routing_shards: type: number check_on_startup: default: 'false' allOf: - $ref: '#/components/schemas/indices._types.IndexCheckOnStartup' codec: default: LZ4 type: string routing_partition_size: default: '1' allOf: - $ref: '#/components/schemas/_spec_utils.Stringifiedinteger' load_fixed_bitset_filters_eagerly: default: true type: boolean hidden: default: 'false' oneOf: - type: boolean - type: string auto_expand_replicas: default: 'false' oneOf: - type: string - $ref: '#/components/schemas/_spec_utils.NullValue' merge: allOf: - $ref: '#/components/schemas/indices._types.Merge' search: allOf: - $ref: '#/components/schemas/indices._types.SettingsSearch' refresh_interval: default: 1s allOf: - $ref: '#/components/schemas/_types.Duration' max_result_window: default: 10000.0 type: number max_inner_result_window: default: 100.0 type: number max_rescore_window: default: 10000.0 type: number max_docvalue_fields_search: default: 100.0 type: number max_script_fields: default: 32.0 type: number max_ngram_diff: default: 1.0 type: number max_shingle_diff: default: 3.0 type: number blocks: allOf: - $ref: '#/components/schemas/indices._types.IndexSettingBlocks' max_refresh_listeners: type: number analyze: externalDocs: url: https://www.elastic.co/docs/manage-data/data-store/text-analysis/specify-an-analyzer#update-analyzers-on-existing-indices description: 'Settings to define analyzers, tokenizers, token filters and character filters. Refer to the linked documentation for step-by-step examples of updating analyzers on existing indices.' allOf: - $ref: '#/components/schemas/indices._types.SettingsAnalyze' highlight: allOf: - $ref: '#/components/schemas/indices._types.SettingsHighlight' max_terms_count: default: 65536.0 type: number max_regex_length: default: 1000.0 type: number routing: allOf: - $ref: '#/components/schemas/indices._types.IndexRouting' unassigned: allOf: - $ref: '#/components/schemas/indices._types.IndexSettingsUnassigned' gc_deletes: default: 60s allOf: - $ref: '#/components/schemas/_types.Duration' default_pipeline: default: _none allOf: - $ref: '#/components/schemas/_types.PipelineName' final_pipeline: default: _none allOf: - $ref: '#/components/schemas/_types.PipelineName' lifecycle: allOf: - $ref: '#/components/schemas/indices._types.IndexSettingsLifecycle' provided_name: allOf: - $ref: '#/components/schemas/_types.Name' creation_date: allOf: - $ref: '#/components/schemas/_spec_utils.StringifiedEpochTimeUnitMillis' creation_date_string: allOf: - $ref: '#/components/schemas/_types.DateTime' uuid: allOf: - $ref: '#/components/schemas/_types.Uuid' version: allOf: - $ref: '#/components/schemas/indices._types.IndexVersioning' verified_before_close: oneOf: - type: boolean - type: string format: oneOf: - type: string - type: number max_slices_per_scroll: type: number translog: allOf: - $ref: '#/components/schemas/indices._types.Translog' query_string: allOf: - $ref: '#/components/schemas/indices._types.SettingsQueryString' priority: oneOf: - type: number - type: string top_metrics_max_size: type: number analysis: allOf: - $ref: '#/components/schemas/indices._types.IndexSettingsAnalysis' settings: allOf: - $ref: '#/components/schemas/indices._types.IndexSettings' time_series: allOf: - $ref: '#/components/schemas/indices._types.IndexSettingsTimeSeries' queries: allOf: - $ref: '#/components/schemas/indices._types.Queries' similarity: description: Configure custom similarity settings to customize how search results are scored. type: object additionalProperties: $ref: '#/components/schemas/indices._types.SettingsSimilarity' mapping: description: Enable or disable dynamic mapping for an index. allOf: - $ref: '#/components/schemas/indices._types.MappingLimitSettings' indexing.slowlog: allOf: - $ref: '#/components/schemas/indices._types.IndexingSlowlogSettings' indexing_pressure: description: Configure indexing back pressure limits. allOf: - $ref: '#/components/schemas/indices._types.IndexingPressure' store: description: The store module allows you to control how index data is stored and accessed on disk. allOf: - $ref: '#/components/schemas/indices._types.Storage' _types.analysis.PredicateTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - predicate_token_filter script: description: Script containing a condition used to filter incoming tokens. Only tokens that match this script are included in the output. allOf: - $ref: '#/components/schemas/_types.Script' required: - type - script _types.ByteSize: oneOf: - type: number - type: string _types.mapping.ShortNumberProperty: allOf: - $ref: '#/components/schemas/_types.mapping.NumberPropertyBase' - type: object properties: type: type: string enum: - short null_value: allOf: - $ref: '#/components/schemas/_types.short' required: - type _types.analysis.SwedishAnalyzer: type: object properties: type: type: string enum: - swedish stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type _types.query_dsl.TermsQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object indices.recovery.FileDetails: type: object properties: length: type: number name: type: string recovered: type: number required: - length - name - recovered _types.QueryCacheStats: type: object properties: cache_count: description: 'Total number of entries added to the query cache across all shards assigned to selected nodes. This number includes current and evicted entries.' type: number cache_size: description: Total number of entries currently in the query cache across all shards assigned to selected nodes. type: number evictions: description: Total number of query cache evictions across all shards assigned to selected nodes. type: number hit_count: description: Total count of query cache hits across all shards assigned to selected nodes. type: number memory_size: description: Total amount of memory used for the query cache across all shards assigned to selected nodes. allOf: - $ref: '#/components/schemas/_types.ByteSize' memory_size_in_bytes: description: Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes. type: number miss_count: description: Total count of query cache misses across all shards assigned to selected nodes. type: number total_count: description: Total count of hits and misses in the query cache across all shards assigned to selected nodes. type: number required: - cache_count - cache_size - evictions - hit_count - memory_size_in_bytes - miss_count - total_count indices._types.IndexTemplateSummaryWithRollover: type: object properties: lifecycle: x-state: Generally available; Added in 8.11.0 allOf: - $ref: '#/components/schemas/indices._types.DataStreamLifecycleWithRollover' aliases: description: 'Aliases to add. If the index template includes a `data_stream` object, these are data stream aliases. Otherwise, these are index aliases. Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options.' type: object additionalProperties: $ref: '#/components/schemas/indices._types.Alias' mappings: description: 'Mapping for fields in the index. If specified, this mapping can include field names, field data types, and mapping parameters.' allOf: - $ref: '#/components/schemas/_types.mapping.TypeMapping' settings: description: Configuration options for the index. allOf: - $ref: '#/components/schemas/indices._types.IndexSettings' data_stream_options: x-state: Generally available; Added in 8.19.0 allOf: - $ref: '#/components/schemas/indices._types.DataStreamOptions' _global.search._types.BoundaryScanner: type: string enum: - chars - sentence - word _types.ScoreNormalizer: type: string enum: - none - minmax - l2_norm _types.analysis.IcuNormalizationCharFilter: allOf: - $ref: '#/components/schemas/_types.analysis.CharFilterBase' - type: object properties: type: type: string enum: - icu_normalizer mode: allOf: - $ref: '#/components/schemas/_types.analysis.IcuNormalizationMode' name: allOf: - $ref: '#/components/schemas/_types.analysis.IcuNormalizationType' unicode_set_filter: type: string required: - type _types.aggregations.GeohexGridAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: field: description: 'Field containing indexed `geo_point` or `geo_shape` values. If the field contains an array, `geohex_grid` aggregates all array values.' allOf: - $ref: '#/components/schemas/_types.Field' precision: description: 'Integer zoom of the key used to defined cells or buckets in the results. Value should be between 0-15.' default: 6.0 type: number bounds: description: Bounding box used to filter the geo-points in each bucket. allOf: - $ref: '#/components/schemas/_types.GeoBounds' size: description: Maximum number of buckets to return. default: 10000.0 type: number shard_size: description: Number of buckets returned from each shard. type: number required: - field _types.Field: description: Path to field or array of paths. Some API's support wildcards in the path to select multiple fields. type: string _types.mapping.DynamicMapping: type: string enum: - strict - runtime - 'true' - 'false' indices._types.SettingsQueryString: type: object properties: lenient: allOf: - $ref: '#/components/schemas/_spec_utils.Stringifiedboolean' required: - lenient _types.analysis.NGramTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - ngram max_gram: description: Maximum length of characters in a gram. Defaults to `2`. type: number min_gram: description: Minimum length of characters in a gram. Defaults to `1`. type: number preserve_original: description: Emits original token when set to `true`. Defaults to `false`. allOf: - $ref: '#/components/schemas/_spec_utils.Stringifiedboolean' required: - type _types.query_dsl.RankFeatureFunctionSaturation: allOf: - $ref: '#/components/schemas/_types.query_dsl.RankFeatureFunction' - type: object properties: pivot: description: Configurable pivot value so that the result will be less than 0.5. type: number _types.aggregations.StatsAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase' - type: object _types.analysis.ElisionTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - elision articles: description: 'List of elisions to remove. To be removed, the elision must be at the beginning of a token and be immediately followed by an apostrophe. Both the elision and apostrophe are removed. For custom `elision` filters, either this parameter or `articles_path` must be specified.' type: array items: type: string articles_path: description: 'Path to a file that contains a list of elisions to remove. This path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each elision in the file must be separated by a line break. To be removed, the elision must be at the beginning of a token and be immediately followed by an apostrophe. Both the elision and apostrophe are removed. For custom `elision` filters, either this parameter or `articles` must be specified.' type: string articles_case: description: If `true`, elision matching is case insensitive. If `false`, elision matching is case sensitive. Defaults to `false`. allOf: - $ref: '#/components/schemas/_spec_utils.Stringifiedboolean' required: - type _types.mapping.TermVectorOption: type: string enum: - 'no' - 'yes' - with_offsets - with_positions - with_positions_offsets - with_positions_offsets_payloads - with_positions_payloads _types.analysis.LithuanianAnalyzer: type: object properties: type: type: string enum: - lithuanian stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type _types.GeoDistanceSort: type: object properties: mode: allOf: - $ref: '#/components/schemas/_types.SortMode' distance_type: allOf: - $ref: '#/components/schemas/_types.GeoDistanceType' ignore_unmapped: type: boolean order: allOf: - $ref: '#/components/schemas/_types.SortOrder' unit: allOf: - $ref: '#/components/schemas/_types.DistanceUnit' nested: allOf: - $ref: '#/components/schemas/_types.NestedSortValue' _types.mapping.SemanticTextIndexOptions: type: object properties: dense_vector: allOf: - $ref: '#/components/schemas/_types.mapping.DenseVectorIndexOptions' sparse_vector: allOf: - $ref: '#/components/schemas/_types.mapping.SparseVectorIndexOptions' indices.analyze.AnalyzeToken: type: object properties: end_offset: type: number position: type: number positionLength: type: number start_offset: type: number token: type: string type: type: string required: - end_offset - position - start_offset - token - type _types.DateMath: type: string _types.analysis.KeywordMarkerTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - keyword_marker ignore_case: description: If `true`, matching for the `keywords` and `keywords_path` parameters ignores letter case. Defaults to `false`. type: boolean keywords: description: 'Array of keywords. Tokens that match these keywords are not stemmed. This parameter, `keywords_path`, or `keywords_pattern` must be specified. You cannot specify this parameter and `keywords_pattern`.' oneOf: - type: string - type: array items: type: string keywords_path: description: 'Path to a file that contains a list of keywords. Tokens that match these keywords are not stemmed. This path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each word in the file must be separated by a line break. This parameter, `keywords`, or `keywords_pattern` must be specified. You cannot specify this parameter and `keywords_pattern`.' type: string keywords_pattern: description: 'Java regular expression used to match tokens. Tokens that match this expression are marked as keywords and not stemmed. This parameter, `keywords`, or `keywords_path` must be specified. You cannot specify this parameter and `keywords` or `keywords_pattern`.' type: string required: - type _types.mapping.RuntimeFields: type: object additionalProperties: $ref: '#/components/schemas/_types.mapping.RuntimeField' indices.recovery.RecoveryStage: type: string enum: - INIT - INDEX - VERIFY_INDEX - TRANSLOG - FINALIZE - DONE _types.TimeZone: type: string indices.analyze.TokenDetail: type: object properties: name: type: string tokens: type: array items: $ref: '#/components/schemas/indices.analyze.ExplainAnalyzeToken' required: - name - tokens _types.analysis.KeywordTokenizer: allOf: - $ref: '#/components/schemas/_types.analysis.TokenizerBase' - type: object properties: type: type: string enum: - keyword buffer_size: default: 256.0 type: number required: - type _types.query_dsl.MatchPhrasePrefixQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: analyzer: description: Analyzer used to convert text in the query value into tokens. type: string max_expansions: description: Maximum number of terms to which the last provided term of the query value will expand. default: 50.0 type: number query: description: Text you wish to find in the provided field. type: string slop: description: Maximum number of positions allowed between matching tokens. default: 0.0 type: number zero_terms_query: description: Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter. default: none allOf: - $ref: '#/components/schemas/_types.query_dsl.ZeroTermsQuery' required: - query _types.analysis.KeepTypesMode: type: string enum: - include - exclude indices._types.DownsamplingRound: type: object properties: after: description: The duration since rollover when this downsampling round should execute allOf: - $ref: '#/components/schemas/_types.Duration' fixed_interval: description: The downsample interval. allOf: - $ref: '#/components/schemas/_types.DurationLarge' required: - after - fixed_interval _types.FieldSizeUsage: type: object properties: size: allOf: - $ref: '#/components/schemas/_types.ByteSize' size_in_bytes: type: number required: - size_in_bytes _types.aggregations.CartesianCentroidAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase' - type: object _types.Embedding: type: object properties: inference_id: type: string input: allOf: - $ref: '#/components/schemas/_types.KnnEmbeddingInput' timeout: allOf: - $ref: '#/components/schemas/_types.Duration' required: - input _types.analysis.TokenFilter: externalDocs: url: https://www.elastic.co/docs/reference/text-analysis/token-filter-reference oneOf: - type: string - $ref: '#/components/schemas/_types.analysis.TokenFilterDefinition' _types.analysis.CustomAnalyzer: type: object properties: type: type: string enum: - custom char_filter: oneOf: - type: string - type: array items: type: string filter: oneOf: - type: string - type: array items: type: string position_increment_gap: type: number position_offset_gap: type: number tokenizer: type: string required: - type - tokenizer _types.mapping.ObjectProperty: allOf: - $ref: '#/components/schemas/_types.mapping.CorePropertyBase' - type: object properties: enabled: type: boolean subobjects: allOf: - $ref: '#/components/schemas/_types.mapping.Subobjects' type: type: string enum: - object _types.analysis.EdgeNGramTokenizer: allOf: - $ref: '#/components/schemas/_types.analysis.TokenizerBase' - type: object properties: type: type: string enum: - edge_ngram custom_token_chars: type: string max_gram: type: number min_gram: type: number token_chars: default: [] type: array items: $ref: '#/components/schemas/_types.analysis.TokenChar' required: - type indices.shard_stores.ShardStoreWrapper: type: object properties: stores: type: array items: $ref: '#/components/schemas/indices.shard_stores.ShardStore' required: - stores _types.query_dsl.SpanTermQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: value: allOf: - $ref: '#/components/schemas/_types.FieldValue' required: - value indices.segments.Segment: type: object properties: attributes: description: Contains information about whether high compression was enabled and per-field vector formats. type: object additionalProperties: type: string committed: description: 'If `true`, the segment is synced to disk. Segments that are synced can survive a hard reboot. If `false`, the data from uncommitted segments is also stored in the transaction log so that Elasticsearch is able to replay changes on the next start.' type: boolean compound: description: If `true`, Lucene merged all files from the segment into a single file to save file descriptors. type: boolean deleted_docs: description: 'The number of deleted documents as reported by Lucene, which may be higher or lower than the number of delete operations you have performed. This number excludes deletes that were performed recently and do not yet belong to a segment. Deleted documents are cleaned up by the automatic merge process if it makes sense to do so. Also, Elasticsearch creates extra deleted documents to internally track the recent history of operations on a shard.' type: number generation: description: Generation number, such as `0`. Elasticsearch increments this generation number for each segment written then uses this number to derive the segment name. type: number search: description: 'If `true`, the segment is searchable. If `false`, the segment has most likely been written to disk but needs a refresh to be searchable.' type: boolean size_in_bytes: description: Disk space used by the segment, in bytes. type: number num_docs: description: 'The number of documents as reported by Lucene. This excludes deleted documents and counts any nested documents separately from their parents. It also excludes documents which were indexed recently and do not yet belong to a segment.' type: number version: description: Version of Lucene used to write the segment. allOf: - $ref: '#/components/schemas/_types.VersionString' required: - attributes - committed - compound - deleted_docs - generation - search - size_in_bytes - num_docs - version _types.CoordsGeoBounds: type: object properties: top: type: number bottom: type: number left: type: number right: type: number required: - top - bottom - left - right _types.query_dsl.MultiMatchQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: analyzer: description: Analyzer used to convert the text in the query value into tokens. type: string auto_generate_synonyms_phrase_query: description: If `true`, match phrase queries are automatically created for multi-term synonyms. default: true type: boolean cutoff_frequency: deprecated: true type: number fields: description: 'The fields to be queried. Defaults to the `index.query.default_field` index settings, which in turn defaults to `*`.' allOf: - $ref: '#/components/schemas/_types.Fields' fuzziness: description: Maximum edit distance allowed for matching. allOf: - $ref: '#/components/schemas/_types.Fuzziness' fuzzy_rewrite: description: Method used to rewrite the query. allOf: - $ref: '#/components/schemas/_types.MultiTermQueryRewrite' fuzzy_transpositions: description: 'If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). Can be applied to the term subqueries constructed for all terms but the final term.' default: true type: boolean lenient: description: If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. default: false type: boolean max_expansions: description: Maximum number of terms to which the query will expand. default: 50.0 type: number minimum_should_match: description: Minimum number of clauses that must match for a document to be returned. allOf: - $ref: '#/components/schemas/_types.MinimumShouldMatch' operator: description: Boolean logic used to interpret text in the query value. default: '''or''' allOf: - $ref: '#/components/schemas/_types.query_dsl.Operator' prefix_length: description: Number of beginning characters left unchanged for fuzzy matching. default: 0.0 type: number query: description: Text, number, boolean value or date you wish to find in the provided field. type: string slop: description: Maximum number of positions allowed between matching tokens. default: 0.0 type: number tie_breaker: description: Determines how scores for each per-term blended query and scores across groups are combined. default: 0.0 type: number type: description: How `the` multi_match query is executed internally. default: '''best_fields''' allOf: - $ref: '#/components/schemas/_types.query_dsl.TextQueryType' zero_terms_query: description: Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. default: '''none''' allOf: - $ref: '#/components/schemas/_types.query_dsl.ZeroTermsQuery' required: - query _types.analysis.BrazilianStemTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - brazilian_stem required: - type _types.InferenceStringGroup: oneOf: - $ref: '#/components/schemas/_types.InferenceString' - type: array items: $ref: '#/components/schemas/_types.InferenceString' _types.query_dsl.GeoExecution: type: string enum: - memory - indexed _types.aggregations.MetricAggregationBase: type: object properties: field: description: The field on which to run the aggregation. allOf: - $ref: '#/components/schemas/_types.Field' missing: description: 'The value to apply to documents that do not have a value. By default, documents without a value are ignored.' allOf: - $ref: '#/components/schemas/_types.aggregations.Missing' script: allOf: - $ref: '#/components/schemas/_types.Script' _types.ExpandWildcard: type: string enum: - all - open - closed - hidden - none _types.query_dsl.UntypedDistanceFeatureQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.DistanceFeatureQueryBase' - type: object _types.Script: type: object properties: source: description: The script source. allOf: - $ref: '#/components/schemas/_types.ScriptSource' id: description: The `id` for a stored script. allOf: - $ref: '#/components/schemas/_types.Id' params: description: 'Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.' type: object additionalProperties: type: object lang: description: Specifies the language the script is written in. default: painless allOf: - $ref: '#/components/schemas/_types.ScriptLanguage' options: type: object additionalProperties: type: string indices._types.SlowlogTresholdLevels: type: object properties: warn: allOf: - $ref: '#/components/schemas/_types.Duration' info: allOf: - $ref: '#/components/schemas/_types.Duration' debug: allOf: - $ref: '#/components/schemas/_types.Duration' trace: allOf: - $ref: '#/components/schemas/_types.Duration' _types.query_dsl.ChildScoreMode: type: string enum: - none - avg - sum - max - min _types.analysis.AsciiFoldingTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - asciifolding preserve_original: description: If `true`, emit both original tokens and folded tokens. Defaults to `false`. allOf: - $ref: '#/components/schemas/_spec_utils.Stringifiedboolean' required: - type _types.GeoLocation: description: 'A latitude/longitude as a 2 dimensional point. It can be represented in various ways: - as a `{lat, long}` object - as a geo hash value - as a `[lon, lat]` array - as a string in `", "` or WKT point formats' oneOf: - $ref: '#/components/schemas/_types.LatLonGeoLocation' - $ref: '#/components/schemas/_types.GeoHashLocation' - type: array items: type: number - type: string _types.mapping.DateProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: boost: type: number fielddata: allOf: - $ref: '#/components/schemas/indices._types.NumericFielddata' format: type: string ignore_malformed: type: boolean index: type: boolean script: allOf: - $ref: '#/components/schemas/_types.Script' on_script_error: allOf: - $ref: '#/components/schemas/_types.mapping.OnScriptError' null_value: allOf: - $ref: '#/components/schemas/_types.DateTime' precision_step: type: number locale: type: string type: type: string enum: - date required: - type indices._types.IndexTemplateDataStreamConfiguration: type: object properties: hidden: description: If true, the data stream is hidden. default: false type: boolean allow_custom_routing: description: If true, the data stream supports custom routing. default: false type: boolean _types.aggregations.CompositeAggregationBase: type: object properties: field: description: Either `field` or `script` must be present allOf: - $ref: '#/components/schemas/_types.Field' missing_bucket: type: boolean missing_order: allOf: - $ref: '#/components/schemas/_types.aggregations.MissingOrder' script: description: Either `field` or `script` must be present allOf: - $ref: '#/components/schemas/_types.Script' value_type: allOf: - $ref: '#/components/schemas/_types.aggregations.ValueType' order: allOf: - $ref: '#/components/schemas/_types.SortOrder' indices._types.IndexRouting: type: object properties: allocation: allOf: - $ref: '#/components/schemas/indices._types.IndexRoutingAllocation' rebalance: allOf: - $ref: '#/components/schemas/indices._types.IndexRoutingRebalance' _types.analysis.PersianStemTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - persian_stem required: - type indices.shard_stores.ShardStore: type: object properties: allocation: description: The status of the store copy, whether it is used as a primary, replica, or not used at all. allOf: - $ref: '#/components/schemas/indices.shard_stores.ShardStoreAllocation' allocation_id: description: The allocation ID of the store copy. allOf: - $ref: '#/components/schemas/_types.Id' store_exception: description: Any exception encountered while opening the shard index or from an earlier engine failure. allOf: - $ref: '#/components/schemas/indices.shard_stores.ShardStoreException' required: - allocation _types.aggregations.MatrixStatsAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MatrixAggregation' - type: object properties: mode: description: Array value the aggregation will use for array or multi-valued fields. default: avg allOf: - $ref: '#/components/schemas/_types.SortMode' _types.aggregations.TTestAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.Aggregation' - type: object properties: a: description: Test population A. allOf: - $ref: '#/components/schemas/_types.aggregations.TestPopulation' b: description: Test population B. allOf: - $ref: '#/components/schemas/_types.aggregations.TestPopulation' type: description: The type of test. default: heteroscedastic allOf: - $ref: '#/components/schemas/_types.aggregations.TTestType' _types.aggregations.ScriptedHeuristic: type: object properties: script: allOf: - $ref: '#/components/schemas/_types.Script' required: - script _types.Level: type: string enum: - cluster - indices - shards _types.IBDistribution: type: string enum: - ll - spl _types.mapping.RuntimeFieldFetchFields: type: object properties: field: allOf: - $ref: '#/components/schemas/_types.Field' format: type: string required: - field _types.aggregations.FrequentItemSetsAggregation: type: object properties: fields: description: Fields to analyze. type: array items: $ref: '#/components/schemas/_types.aggregations.FrequentItemSetsField' minimum_set_size: description: The minimum size of one item set. default: 1.0 type: number minimum_support: description: The minimum support of one item set. default: 0.1 type: number size: description: The number of top item sets to return. default: 10.0 type: number filter: description: Query that filters documents from analysis. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' required: - fields _types.aggregations.FiltersAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: filters: description: Collection of queries from which to build buckets. allOf: - $ref: '#/components/schemas/_types.aggregations.BucketsQueryContainer' other_bucket: description: Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters. type: boolean other_bucket_key: description: The key with which the other bucket is returned. default: _other_ type: string keyed: description: 'By default, the named filters aggregation returns the buckets as an object. Set to `false` to return the buckets as an array of objects.' default: true type: boolean _types.mapping.RangePropertyBase: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: boost: type: number coerce: type: boolean index: type: boolean _types.query_dsl.IntervalsAnyOf: type: object properties: intervals: description: An array of rules to match. type: array items: $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer' filter: description: Rule used to filter returned intervals. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsFilter' required: - intervals _types.aggregations.PValueHeuristic: type: object properties: background_is_superset: type: boolean normalize_above: description: 'Should the results be normalized when above the given value. Allows for consistent significance results at various scales. Note: `0` is a special value which means no normalization' default: 0.0 type: number _types.analysis.DecimalDigitTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - decimal_digit required: - type _types.aggregations.BucketCorrelationAggregation: description: A sibling pipeline aggregation which executes a correlation function on the configured sibling multi-bucket aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.BucketPathAggregation' - type: object properties: function: description: The correlation function to execute. allOf: - $ref: '#/components/schemas/_types.aggregations.BucketCorrelationFunction' required: - function _types.GeoTile: description: A map tile reference, represented as `{zoom}/{x}/{y}` type: string indices._types.SlowlogSettings: type: object properties: level: type: string source: type: number reformat: type: boolean threshold: allOf: - $ref: '#/components/schemas/indices._types.SlowlogTresholds' _types.analysis.TokenFilterDefinition: discriminator: propertyName: type mapping: apostrophe: '#/components/schemas/_types.analysis.ApostropheTokenFilter' arabic_normalization: '#/components/schemas/_types.analysis.ArabicNormalizationTokenFilter' arabic_stem: '#/components/schemas/_types.analysis.ArabicStemTokenFilter' asciifolding: '#/components/schemas/_types.analysis.AsciiFoldingTokenFilter' bengali_normalization: '#/components/schemas/_types.analysis.BengaliNormalizationTokenFilter' brazilian_stem: '#/components/schemas/_types.analysis.BrazilianStemTokenFilter' cjk_bigram: '#/components/schemas/_types.analysis.CjkBigramTokenFilter' cjk_width: '#/components/schemas/_types.analysis.CjkWidthTokenFilter' classic: '#/components/schemas/_types.analysis.ClassicTokenFilter' common_grams: '#/components/schemas/_types.analysis.CommonGramsTokenFilter' condition: '#/components/schemas/_types.analysis.ConditionTokenFilter' czech_stem: '#/components/schemas/_types.analysis.CzechStemTokenFilter' decimal_digit: '#/components/schemas/_types.analysis.DecimalDigitTokenFilter' delimited_payload: '#/components/schemas/_types.analysis.DelimitedPayloadTokenFilter' dictionary_decompounder: '#/components/schemas/_types.analysis.DictionaryDecompounderTokenFilter' dutch_stem: '#/components/schemas/_types.analysis.DutchStemTokenFilter' edge_ngram: '#/components/schemas/_types.analysis.EdgeNGramTokenFilter' elision: '#/components/schemas/_types.analysis.ElisionTokenFilter' fingerprint: '#/components/schemas/_types.analysis.FingerprintTokenFilter' flatten_graph: '#/components/schemas/_types.analysis.FlattenGraphTokenFilter' french_stem: '#/components/schemas/_types.analysis.FrenchStemTokenFilter' german_normalization: '#/components/schemas/_types.analysis.GermanNormalizationTokenFilter' german_stem: '#/components/schemas/_types.analysis.GermanStemTokenFilter' hindi_normalization: '#/components/schemas/_types.analysis.HindiNormalizationTokenFilter' hunspell: '#/components/schemas/_types.analysis.HunspellTokenFilter' hyphenation_decompounder: '#/components/schemas/_types.analysis.HyphenationDecompounderTokenFilter' icu_collation: '#/components/schemas/_types.analysis.IcuCollationTokenFilter' icu_folding: '#/components/schemas/_types.analysis.IcuFoldingTokenFilter' icu_normalizer: '#/components/schemas/_types.analysis.IcuNormalizationTokenFilter' icu_transform: '#/components/schemas/_types.analysis.IcuTransformTokenFilter' indic_normalization: '#/components/schemas/_types.analysis.IndicNormalizationTokenFilter' ja_stop: '#/components/schemas/_types.analysis.JaStopTokenFilter' keep: '#/components/schemas/_types.analysis.KeepWordsTokenFilter' keep_types: '#/components/schemas/_types.analysis.KeepTypesTokenFilter' keyword_marker: '#/components/schemas/_types.analysis.KeywordMarkerTokenFilter' keyword_repeat: '#/components/schemas/_types.analysis.KeywordRepeatTokenFilter' kstem: '#/components/schemas/_types.analysis.KStemTokenFilter' kuromoji_part_of_speech: '#/components/schemas/_types.analysis.KuromojiPartOfSpeechTokenFilter' kuromoji_readingform: '#/components/schemas/_types.analysis.KuromojiReadingFormTokenFilter' kuromoji_stemmer: '#/components/schemas/_types.analysis.KuromojiStemmerTokenFilter' length: '#/components/schemas/_types.analysis.LengthTokenFilter' limit: '#/components/schemas/_types.analysis.LimitTokenCountTokenFilter' lowercase: '#/components/schemas/_types.analysis.LowercaseTokenFilter' min_hash: '#/components/schemas/_types.analysis.MinHashTokenFilter' multiplexer: '#/components/schemas/_types.analysis.MultiplexerTokenFilter' ngram: '#/components/schemas/_types.analysis.NGramTokenFilter' nori_part_of_speech: '#/components/schemas/_types.analysis.NoriPartOfSpeechTokenFilter' pattern_capture: '#/components/schemas/_types.analysis.PatternCaptureTokenFilter' pattern_replace: '#/components/schemas/_types.analysis.PatternReplaceTokenFilter' persian_normalization: '#/components/schemas/_types.analysis.PersianNormalizationTokenFilter' persian_stem: '#/components/schemas/_types.analysis.PersianStemTokenFilter' phonetic: '#/components/schemas/_types.analysis.PhoneticTokenFilter' porter_stem: '#/components/schemas/_types.analysis.PorterStemTokenFilter' predicate_token_filter: '#/components/schemas/_types.analysis.PredicateTokenFilter' remove_duplicates: '#/components/schemas/_types.analysis.RemoveDuplicatesTokenFilter' reverse: '#/components/schemas/_types.analysis.ReverseTokenFilter' russian_stem: '#/components/schemas/_types.analysis.RussianStemTokenFilter' scandinavian_folding: '#/components/schemas/_types.analysis.ScandinavianFoldingTokenFilter' scandinavian_normalization: '#/components/schemas/_types.analysis.ScandinavianNormalizationTokenFilter' serbian_normalization: '#/components/schemas/_types.analysis.SerbianNormalizationTokenFilter' shingle: '#/components/schemas/_types.analysis.ShingleTokenFilter' snowball: '#/components/schemas/_types.analysis.SnowballTokenFilter' sorani_normalization: '#/components/schemas/_types.analysis.SoraniNormalizationTokenFilter' stemmer: '#/components/schemas/_types.analysis.StemmerTokenFilter' stemmer_override: '#/components/schemas/_types.analysis.StemmerOverrideTokenFilter' stop: '#/components/schemas/_types.analysis.StopTokenFilter' synonym: '#/components/schemas/_types.analysis.SynonymTokenFilter' synonym_graph: '#/components/schemas/_types.analysis.SynonymGraphTokenFilter' trim: '#/components/schemas/_types.analysis.TrimTokenFilter' truncate: '#/components/schemas/_types.analysis.TruncateTokenFilter' unique: '#/components/schemas/_types.analysis.UniqueTokenFilter' uppercase: '#/components/schemas/_types.analysis.UppercaseTokenFilter' word_delimiter: '#/components/schemas/_types.analysis.WordDelimiterTokenFilter' word_delimiter_graph: '#/components/schemas/_types.analysis.WordDelimiterGraphTokenFilter' oneOf: - $ref: '#/components/schemas/_types.analysis.ApostropheTokenFilter' - $ref: '#/components/schemas/_types.analysis.ArabicStemTokenFilter' - $ref: '#/components/schemas/_types.analysis.ArabicNormalizationTokenFilter' - $ref: '#/components/schemas/_types.analysis.AsciiFoldingTokenFilter' - $ref: '#/components/schemas/_types.analysis.BengaliNormalizationTokenFilter' - $ref: '#/components/schemas/_types.analysis.BrazilianStemTokenFilter' - $ref: '#/components/schemas/_types.analysis.CjkBigramTokenFilter' - $ref: '#/components/schemas/_types.analysis.CjkWidthTokenFilter' - $ref: '#/components/schemas/_types.analysis.ClassicTokenFilter' - $ref: '#/components/schemas/_types.analysis.CommonGramsTokenFilter' - $ref: '#/components/schemas/_types.analysis.ConditionTokenFilter' - $ref: '#/components/schemas/_types.analysis.CzechStemTokenFilter' - $ref: '#/components/schemas/_types.analysis.DecimalDigitTokenFilter' - $ref: '#/components/schemas/_types.analysis.DelimitedPayloadTokenFilter' - $ref: '#/components/schemas/_types.analysis.DutchStemTokenFilter' - $ref: '#/components/schemas/_types.analysis.EdgeNGramTokenFilter' - $ref: '#/components/schemas/_types.analysis.ElisionTokenFilter' - $ref: '#/components/schemas/_types.analysis.FingerprintTokenFilter' - $ref: '#/components/schemas/_types.analysis.FlattenGraphTokenFilter' - $ref: '#/components/schemas/_types.analysis.FrenchStemTokenFilter' - $ref: '#/components/schemas/_types.analysis.GermanNormalizationTokenFilter' - $ref: '#/components/schemas/_types.analysis.GermanStemTokenFilter' - $ref: '#/components/schemas/_types.analysis.HindiNormalizationTokenFilter' - $ref: '#/components/schemas/_types.analysis.HunspellTokenFilter' - $ref: '#/components/schemas/_types.analysis.HyphenationDecompounderTokenFilter' - $ref: '#/components/schemas/_types.analysis.IndicNormalizationTokenFilter' - $ref: '#/components/schemas/_types.analysis.KeepTypesTokenFilter' - $ref: '#/components/schemas/_types.analysis.KeepWordsTokenFilter' - $ref: '#/components/schemas/_types.analysis.KeywordMarkerTokenFilter' - $ref: '#/components/schemas/_types.analysis.KeywordRepeatTokenFilter' - $ref: '#/components/schemas/_types.analysis.KStemTokenFilter' - $ref: '#/components/schemas/_types.analysis.LengthTokenFilter' - $ref: '#/components/schemas/_types.analysis.LimitTokenCountTokenFilter' - $ref: '#/components/schemas/_types.analysis.LowercaseTokenFilter' - $ref: '#/components/schemas/_types.analysis.MinHashTokenFilter' - $ref: '#/components/schemas/_types.analysis.MultiplexerTokenFilter' - $ref: '#/components/schemas/_types.analysis.NGramTokenFilter' - $ref: '#/components/schemas/_types.analysis.NoriPartOfSpeechTokenFilter' - $ref: '#/components/schemas/_types.analysis.PatternCaptureTokenFilter' - $ref: '#/components/schemas/_types.analysis.PatternReplaceTokenFilter' - $ref: '#/components/schemas/_types.analysis.PersianNormalizationTokenFilter' - $ref: '#/components/schemas/_types.analysis.PersianStemTokenFilter' - $ref: '#/components/schemas/_types.analysis.PorterStemTokenFilter' - $ref: '#/components/schemas/_types.analysis.PredicateTokenFilter' - $ref: '#/components/schemas/_types.analysis.RemoveDuplicatesTokenFilter' - $ref: '#/components/schemas/_types.analysis.ReverseTokenFilter' - $ref: '#/components/schemas/_types.analysis.RussianStemTokenFilter' - $ref: '#/components/schemas/_types.analysis.ScandinavianFoldingTokenFilter' - $ref: '#/components/schemas/_types.analysis.ScandinavianNormalizationTokenFilter' - $ref: '#/components/schemas/_types.analysis.SerbianNormalizationTokenFilter' - $ref: '#/components/schemas/_types.analysis.ShingleTokenFilter' - $ref: '#/components/schemas/_types.analysis.SnowballTokenFilter' - $ref: '#/components/schemas/_types.analysis.SoraniNormalizationTokenFilter' - $ref: '#/components/schemas/_types.analysis.StemmerOverrideTokenFilter' - $ref: '#/components/schemas/_types.analysis.StemmerTokenFilter' - $ref: '#/components/schemas/_types.analysis.StopTokenFilter' - $ref: '#/components/schemas/_types.analysis.SynonymGraphTokenFilter' - $ref: '#/components/schemas/_types.analysis.SynonymTokenFilter' - $ref: '#/components/schemas/_types.analysis.TrimTokenFilter' - $ref: '#/components/schemas/_types.analysis.TruncateTokenFilter' - $ref: '#/components/schemas/_types.analysis.UniqueTokenFilter' - $ref: '#/components/schemas/_types.analysis.UppercaseTokenFilter' - $ref: '#/components/schemas/_types.analysis.WordDelimiterGraphTokenFilter' - $ref: '#/components/schemas/_types.analysis.WordDelimiterTokenFilter' - $ref: '#/components/schemas/_types.analysis.JaStopTokenFilter' - $ref: '#/components/schemas/_types.analysis.KuromojiStemmerTokenFilter' - $ref: '#/components/schemas/_types.analysis.KuromojiReadingFormTokenFilter' - $ref: '#/components/schemas/_types.analysis.KuromojiPartOfSpeechTokenFilter' - $ref: '#/components/schemas/_types.analysis.IcuCollationTokenFilter' - $ref: '#/components/schemas/_types.analysis.IcuFoldingTokenFilter' - $ref: '#/components/schemas/_types.analysis.IcuNormalizationTokenFilter' - $ref: '#/components/schemas/_types.analysis.IcuTransformTokenFilter' - $ref: '#/components/schemas/_types.analysis.PhoneticTokenFilter' - $ref: '#/components/schemas/_types.analysis.DictionaryDecompounderTokenFilter' _types.analysis.ArmenianAnalyzer: type: object properties: type: type: string enum: - armenian stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type indices._types.DataStreamOptionsTemplate: description: Data stream options template contains the same information as DataStreamOptions but allows them to be set explicitly to null. type: object properties: failure_store: oneOf: - $ref: '#/components/schemas/indices._types.DataStreamFailureStoreTemplate' - type: - string - 'null' _global.search._types.HighlighterType: anyOf: - type: string enum: - plain - fvh - unified - type: string _types.WktGeoBounds: type: object properties: wkt: type: string required: - wkt _types.aggregations.ChangePointAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object _types.mapping.RuntimeFieldType: type: string enum: - boolean - composite - date - double - geo_point - geo_shape - ip - keyword - long - lookup _types.query_dsl.CombinedFieldsQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: fields: description: List of fields to search. Field wildcard patterns are allowed. Only `text` fields are supported, and they must all have the same search `analyzer`. type: array items: $ref: '#/components/schemas/_types.Field' query: description: 'Text to search for in the provided `fields`. The `combined_fields` query analyzes the provided text before performing a search.' type: string auto_generate_synonyms_phrase_query: description: If true, match phrase queries are automatically created for multi-term synonyms. default: true type: boolean operator: description: Boolean logic used to interpret text in the query value. default: or allOf: - $ref: '#/components/schemas/_types.query_dsl.CombinedFieldsOperator' minimum_should_match: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-minimum-should-match description: Minimum number of clauses that must match for a document to be returned. allOf: - $ref: '#/components/schemas/_types.MinimumShouldMatch' zero_terms_query: description: Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter. default: none allOf: - $ref: '#/components/schemas/_types.query_dsl.CombinedFieldsZeroTerms' required: - fields - query indices.stats.ShardFileSizeInfo: type: object properties: description: type: string size_in_bytes: type: number min_size_in_bytes: type: number max_size_in_bytes: type: number average_size_in_bytes: type: number count: type: number required: - description - size_in_bytes _types.TextEmbedding: type: object properties: model_id: description: 'Model ID is required for all dense_vector fields but may be inferred for semantic_text fields' x-state: Generally available; Added in 8.18.0 type: string model_text: description: The text to be converted into a vector by the specified model type: string required: - model_text indices._types.IndexSettingsAnalysis: type: object properties: analyzer: type: object additionalProperties: $ref: '#/components/schemas/_types.analysis.Analyzer' char_filter: type: object additionalProperties: $ref: '#/components/schemas/_types.analysis.CharFilter' filter: type: object additionalProperties: $ref: '#/components/schemas/_types.analysis.TokenFilter' normalizer: type: object additionalProperties: $ref: '#/components/schemas/_types.analysis.Normalizer' tokenizer: type: object additionalProperties: $ref: '#/components/schemas/_types.analysis.Tokenizer' _types.mapping.FloatRangeProperty: allOf: - $ref: '#/components/schemas/_types.mapping.RangePropertyBase' - type: object properties: type: type: string enum: - float_range required: - type _types.analysis.KuromojiReadingFormTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - kuromoji_readingform use_romaji: type: boolean required: - type - use_romaji _types.analysis.Normalizer: discriminator: propertyName: type mapping: custom: '#/components/schemas/_types.analysis.CustomNormalizer' lowercase: '#/components/schemas/_types.analysis.LowercaseNormalizer' oneOf: - $ref: '#/components/schemas/_types.analysis.LowercaseNormalizer' - $ref: '#/components/schemas/_types.analysis.CustomNormalizer' indices._types.IndexingSlowlogSettings: type: object properties: level: type: string source: type: number reformat: type: boolean threshold: allOf: - $ref: '#/components/schemas/indices._types.IndexingSlowlogTresholds' _types.RescorerRetriever: allOf: - $ref: '#/components/schemas/_types.RetrieverBase' - type: object properties: retriever: description: Inner retriever. allOf: - $ref: '#/components/schemas/_types.RetrieverContainer' rescore: oneOf: - $ref: '#/components/schemas/_global.search._types.Rescore' - type: array items: $ref: '#/components/schemas/_global.search._types.Rescore' required: - retriever - rescore _types.query_dsl.DistanceFeatureQuery: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-distance-feature-query oneOf: - $ref: '#/components/schemas/_types.query_dsl.UntypedDistanceFeatureQuery' - $ref: '#/components/schemas/_types.query_dsl.GeoDistanceFeatureQuery' - $ref: '#/components/schemas/_types.query_dsl.DateDistanceFeatureQuery' dangling_indices.list_dangling_indices.DanglingIndex: type: object properties: index_name: type: string index_uuid: type: string creation_date_millis: allOf: - $ref: '#/components/schemas/_types.EpochTimeUnitMillis' node_ids: allOf: - $ref: '#/components/schemas/_types.Ids' required: - index_name - index_uuid - creation_date_millis - node_ids _types.mapping.SemanticTextProperty: type: object properties: type: type: string enum: - semantic_text meta: type: object additionalProperties: type: string inference_id: description: 'Inference endpoint that will be used to generate embeddings for the field. This parameter cannot be updated. Use the Create inference API to create the endpoint. If `search_inference_id` is specified, the inference endpoint will only be used at index time. If the `inference_id` is not specified, it will default to `.jina-embeddings-v5-text-small` if the cluster is authorized to use the Elastic Inference Service, otherwise it will default to `.elser-2-elasticsearch`. The `.elser-2-elasticsearch` inference endpoint relies on a local ML node to run the ELSER model.' default: .jina-embeddings-v5-text-small allOf: - $ref: '#/components/schemas/_types.Id' search_inference_id: description: 'Inference endpoint that will be used to generate embeddings at query time. You can update this parameter by using the Update mapping API. Use the Create inference API to create the endpoint. If not specified, the inference endpoint defined by inference_id will be used at both index and query time.' allOf: - $ref: '#/components/schemas/_types.Id' index_options: description: 'Settings for index_options that override any defaults used by semantic_text, for example specific quantization settings.' allOf: - $ref: '#/components/schemas/_types.mapping.SemanticTextIndexOptions' chunking_settings: description: 'Settings for chunking text into smaller passages. If specified, these will override the chunking settings sent in the inference endpoint associated with inference_id. If chunking settings are updated, they will not be applied to existing documents until they are reindexed.' oneOf: - $ref: '#/components/schemas/_types.mapping.ChunkingSettings' - type: - string - 'null' fields: description: 'Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one field for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers.' type: object additionalProperties: $ref: '#/components/schemas/_types.mapping.Property' required: - type _types.analysis.ConditionTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - condition filter: description: Array of token filters. If a token matches the predicate script in the `script` parameter, these filters are applied to the token in the order provided. type: array items: type: string script: description: Predicate script used to apply token filters. If a token matches this script, the filters in the `filter` parameter are applied to the token. allOf: - $ref: '#/components/schemas/_types.Script' required: - type - filter - script _types.analysis.WhitespaceAnalyzer: type: object properties: type: type: string enum: - whitespace version: deprecated: true allOf: - $ref: '#/components/schemas/_types.VersionString' required: - type _types.aggregations.CartesianBoundsAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase' - type: object _types.GeoBounds: description: 'A geo bounding box. It can be represented in various ways: - as 4 top/bottom/left/right coordinates - as 2 top_left / bottom_right points - as 2 top_right / bottom_left points - as a WKT bounding box' oneOf: - $ref: '#/components/schemas/_types.CoordsGeoBounds' - $ref: '#/components/schemas/_types.TopLeftBottomRightGeoBounds' - $ref: '#/components/schemas/_types.TopRightBottomLeftGeoBounds' - $ref: '#/components/schemas/_types.WktGeoBounds' _global.search._types.SearchRequestBody: type: object properties: aggregations: externalDocs: url: https://www.elastic.co/docs/explore-analyze/query-filter/aggregations description: Defines the aggregations that are run as part of the search request. type: object additionalProperties: $ref: '#/components/schemas/_types.aggregations.AggregationContainer' collapse: description: Collapses search results the values of the specified field. allOf: - $ref: '#/components/schemas/_global.search._types.FieldCollapse' explain: description: If `true`, the request returns detailed information about score computation as part of a hit. default: false type: boolean ext: description: Configuration of search extensions defined by Elasticsearch plugins. type: object additionalProperties: type: object from: description: 'The starting document offset, which must be non-negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter.' default: 0.0 type: number highlight: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/highlighting description: Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results. allOf: - $ref: '#/components/schemas/_global.search._types.Highlight' track_total_hits: description: 'Number of hits matching the query to count accurately. If `true`, the exact number of hits is returned at the cost of some performance. If `false`, the response does not include the total number of hits matching the query.' default: '10000' allOf: - $ref: '#/components/schemas/_global.search._types.TrackHits' indices_boost: externalDocs: url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl#relevance-scores description: 'Boost the `_score` of documents from specified indices. The boost value is the factor by which scores are multiplied. A boost value greater than `1.0` increases the score. A boost value between `0` and `1.0` decreases the score.' type: array items: type: object additionalProperties: type: number minProperties: 1 maxProperties: 1 docvalue_fields: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#docvalue-fields description: 'An array of wildcard (`*`) field patterns. The request returns doc values for field names matching these patterns in the `hits.fields` property of the response.' type: array items: $ref: '#/components/schemas/_types.query_dsl.FieldAndFormat' knn: externalDocs: url: https://www.elastic.co/docs/solutions/search/vector/knn#approximate-knn description: The approximate kNN search to run. x-state: Generally available; Added in 8.4.0 oneOf: - $ref: '#/components/schemas/_types.KnnSearch' - type: array items: $ref: '#/components/schemas/_types.KnnSearch' rank: description: The Reciprocal Rank Fusion (RRF) to use. x-state: Generally available; Added in 8.8.0 allOf: - $ref: '#/components/schemas/_types.RankContainer' min_score: description: 'The minimum `_score` for matching documents. Documents with a lower `_score` are not included in search results or results collected by aggregations.' type: number post_filter: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/filter-search-results description: 'Use the `post_filter` parameter to filter search results. The search hits are filtered after the aggregations are calculated. A post filter has no impact on the aggregation results.' allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' profile: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/search-profile description: 'Set to `true` to return detailed timing information about the execution of individual components in a search request. NOTE: This is a debugging tool and adds significant overhead to search execution.' default: false type: boolean query: externalDocs: url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl description: The search definition using the Query DSL. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' rescore: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/rescore-search-results description: Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases. oneOf: - $ref: '#/components/schemas/_global.search._types.Rescore' - type: array items: $ref: '#/components/schemas/_global.search._types.Rescore' retriever: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrievers description: 'A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as `query` and `knn`.' x-state: Generally available; Added in 8.14.0 allOf: - $ref: '#/components/schemas/_types.RetrieverContainer' script_fields: description: Retrieve a script evaluation (based on different fields) for each hit. type: object additionalProperties: $ref: '#/components/schemas/_types.ScriptField' search_after: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#search-after description: Used to retrieve the next page of hits using a set of sort values from the previous page. allOf: - $ref: '#/components/schemas/_types.SortResults' size: description: 'The number of hits to return, which must not be negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` property.' default: 10.0 type: number slice: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/paginate-search-results#slice-scroll description: Split a scrolled search into multiple slices that can be consumed independently. allOf: - $ref: '#/components/schemas/_types.SlicedScroll' sort: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results description: A comma-separated list of : pairs. allOf: - $ref: '#/components/schemas/_types.Sort' _source: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#source-filtering description: 'The source fields that are returned for matching documents. These fields are returned in the `hits._source` property of the search response. If the `stored_fields` property is specified, the `_source` property defaults to `false`. Otherwise, it defaults to `true`.' allOf: - $ref: '#/components/schemas/_global.search._types.SourceConfig' fields: description: 'An array of wildcard (`*`) field patterns. The request returns values for field names matching these patterns in the `hits.fields` property of the response.' type: array items: $ref: '#/components/schemas/_types.query_dsl.FieldAndFormat' suggest: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/search-suggesters description: Defines a suggester that provides similar looking terms based on a provided text. allOf: - $ref: '#/components/schemas/_global.search._types.Suggester' terminate_after: description: 'The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. IMPORTANT: Use with caution. Elasticsearch applies this property to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this property for requests that target data streams with backing indices across multiple data tiers. If set to `0` (default), the query does not terminate early.' default: 0.0 type: number timeout: description: 'The period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.' type: string track_scores: description: If `true`, calculate and return document scores, even if the scores are not used for sorting. default: false type: boolean version: description: If `true`, the request returns the document version as part of a hit. default: false type: boolean seq_no_primary_term: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control description: If `true`, the request returns sequence number and primary term of the last modification of each hit. type: boolean stored_fields: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#stored-fields description: 'A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` property defaults to `false`. You can pass `_source: true` to return both source fields and stored fields in the search response.' allOf: - $ref: '#/components/schemas/_types.Fields' pit: description: 'Limit the search to a point in time (PIT). If you provide a PIT, you cannot specify an `` in the request path.' allOf: - $ref: '#/components/schemas/_global.search._types.PointInTimeReference' runtime_mappings: externalDocs: url: https://www.elastic.co/docs/manage-data/data-store/mapping/define-runtime-fields-in-search-request description: 'One or more runtime fields in the search request. These fields take precedence over mapped fields with the same name.' allOf: - $ref: '#/components/schemas/_types.mapping.RuntimeFields' stats: description: 'The stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API.' type: array items: type: string _types.mapping.IpProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: boost: type: number index: type: boolean ignore_malformed: type: boolean null_value: type: string on_script_error: allOf: - $ref: '#/components/schemas/_types.mapping.OnScriptError' script: allOf: - $ref: '#/components/schemas/_types.Script' time_series_dimension: description: For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. x-state: Experimental type: boolean type: type: string enum: - ip required: - type _types.analysis.HungarianAnalyzer: type: object properties: type: type: string enum: - hungarian stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type _types.analysis.IcuCollationTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - icu_collation alternate: allOf: - $ref: '#/components/schemas/_types.analysis.IcuCollationAlternate' caseFirst: allOf: - $ref: '#/components/schemas/_types.analysis.IcuCollationCaseFirst' caseLevel: type: boolean country: type: string decomposition: allOf: - $ref: '#/components/schemas/_types.analysis.IcuCollationDecomposition' hiraganaQuaternaryMode: type: boolean language: type: string numeric: type: boolean rules: type: string strength: allOf: - $ref: '#/components/schemas/_types.analysis.IcuCollationStrength' variableTop: type: string variant: type: string required: - type indices._types.IndicesBlockOptions: type: string enum: - metadata - read - read_only - write _types.TopLeftBottomRightGeoBounds: type: object properties: top_left: allOf: - $ref: '#/components/schemas/_types.GeoLocation' bottom_right: allOf: - $ref: '#/components/schemas/_types.GeoLocation' required: - top_left - bottom_right indices.reload_search_analyzers.ReloadDetails: type: object properties: index: type: string reloaded_analyzers: type: array items: type: string reloaded_node_ids: type: array items: type: string required: - index - reloaded_analyzers - reloaded_node_ids _types.query_dsl.IntervalsQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-intervals-query type: object properties: all_of: description: Returns matches that span a combination of other rules. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsAllOf' any_of: description: Returns intervals produced by any of its sub-rules. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsAnyOf' fuzzy: description: Matches terms that are similar to the provided term, within an edit distance defined by `fuzziness`. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsFuzzy' match: description: Matches analyzed text. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsMatch' prefix: description: Matches terms that start with a specified set of characters. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsPrefix' range: allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsRange' regexp: allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsRegexp' wildcard: description: Matches terms using a wildcard pattern. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsWildcard' minProperties: 1 maxProperties: 1 _types.NestedSortValue: type: object properties: filter: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' max_children: type: number nested: allOf: - $ref: '#/components/schemas/_types.NestedSortValue' path: allOf: - $ref: '#/components/schemas/_types.Field' required: - path indices.update_aliases.RemoveIndexAction: type: object properties: index: description: 'Data stream or index for the action. Supports wildcards (`*`).' allOf: - $ref: '#/components/schemas/_types.IndexName' indices: description: 'Data streams or indices for the action. Supports wildcards (`*`).' allOf: - $ref: '#/components/schemas/_types.Indices' must_exist: description: If `true`, the alias must exist to perform the action. default: false type: boolean _global.search._types.SourceFilter: type: object properties: exclude_vectors: description: 'If `true`, vector fields are excluded from the returned source. This option takes precedence over `includes`: any vector field will remain excluded even if it matches an `includes` rule.' type: boolean excludes: description: A list of fields to exclude from the returned source. allOf: - $ref: '#/components/schemas/_types.Fields' includes: description: A list of fields to include in the returned source. allOf: - $ref: '#/components/schemas/_types.Fields' _types.query_dsl.RankFeatureFunction: type: object indices.stats.ShardsTotalStats: type: object properties: total_count: type: number required: - total_count _types.QueryVectorBuilder: type: object properties: embedding: allOf: - $ref: '#/components/schemas/_types.Embedding' text_embedding: allOf: - $ref: '#/components/schemas/_types.TextEmbedding' lookup: description: 'Lookup a vector from an existing document. Must reference a dense_vector field and a single value.' x-state: Generally available; Added in 9.4.0 allOf: - $ref: '#/components/schemas/_types.LookupQueryVectorBuilder' minProperties: 1 maxProperties: 1 _types.query_dsl.SpanNotQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: dist: description: 'The number of tokens from within the include span that can’t have overlap with the exclude span. Equivalent to setting both `pre` and `post`.' type: number exclude: description: Span query whose matches must not overlap those returned. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanQuery' include: description: Span query whose matches are filtered. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanQuery' post: description: The number of tokens after the include span that can’t have overlap with the exclude span. default: 0.0 type: number pre: description: The number of tokens before the include span that can’t have overlap with the exclude span. default: 0.0 type: number required: - exclude - include _types.analysis.NoriTokenizer: allOf: - $ref: '#/components/schemas/_types.analysis.TokenizerBase' - type: object properties: type: type: string enum: - nori_tokenizer decompound_mode: allOf: - $ref: '#/components/schemas/_types.analysis.NoriDecompoundMode' discard_punctuation: type: boolean user_dictionary: type: string user_dictionary_rules: type: array items: type: string required: - type _types.analysis.IcuNormalizationType: type: string enum: - nfc - nfkc - nfkc_cf _types.SearchStats: type: object properties: fetch_current: type: number fetch_time: allOf: - $ref: '#/components/schemas/_types.Duration' fetch_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' fetch_total: type: number fetch_failure: type: number open_contexts: type: number query_current: type: number query_time: allOf: - $ref: '#/components/schemas/_types.Duration' query_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' query_total: type: number query_failure: type: number scroll_current: type: number scroll_time: allOf: - $ref: '#/components/schemas/_types.Duration' scroll_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' scroll_total: type: number suggest_current: type: number suggest_time: allOf: - $ref: '#/components/schemas/_types.Duration' suggest_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' suggest_total: type: number recent_search_load: type: number groups: type: object additionalProperties: $ref: '#/components/schemas/_types.SearchStats' required: - fetch_current - fetch_time_in_millis - fetch_total - fetch_failure - query_current - query_time_in_millis - query_total - query_failure - scroll_current - scroll_time_in_millis - scroll_total - suggest_current - suggest_time_in_millis - suggest_total indices._types.IndexRoutingRebalance: type: object properties: enable: allOf: - $ref: '#/components/schemas/indices._types.IndexRoutingRebalanceOptions' required: - enable indices.stats.ShardStats: type: object properties: commit: allOf: - $ref: '#/components/schemas/indices.stats.ShardCommit' completion: allOf: - $ref: '#/components/schemas/_types.CompletionStats' dense_vector: allOf: - $ref: '#/components/schemas/cluster.stats.DenseVectorStats' docs: allOf: - $ref: '#/components/schemas/_types.DocStats' fielddata: allOf: - $ref: '#/components/schemas/_types.FielddataStats' flush: allOf: - $ref: '#/components/schemas/_types.FlushStats' get: allOf: - $ref: '#/components/schemas/_types.GetStats' indexing: allOf: - $ref: '#/components/schemas/_types.IndexingStats' mappings: allOf: - $ref: '#/components/schemas/indices.stats.MappingStats' merges: allOf: - $ref: '#/components/schemas/_types.MergesStats' shard_path: allOf: - $ref: '#/components/schemas/indices.stats.ShardPath' query_cache: allOf: - $ref: '#/components/schemas/indices.stats.ShardQueryCache' recovery: allOf: - $ref: '#/components/schemas/_types.RecoveryStats' refresh: allOf: - $ref: '#/components/schemas/_types.RefreshStats' request_cache: allOf: - $ref: '#/components/schemas/_types.RequestCacheStats' retention_leases: allOf: - $ref: '#/components/schemas/indices.stats.ShardRetentionLeases' routing: allOf: - $ref: '#/components/schemas/indices.stats.ShardRouting' search: allOf: - $ref: '#/components/schemas/_types.SearchStats' segments: allOf: - $ref: '#/components/schemas/_types.SegmentsStats' seq_no: allOf: - $ref: '#/components/schemas/indices.stats.ShardSequenceNumber' sparse_vector: allOf: - $ref: '#/components/schemas/cluster.stats.SparseVectorStats' store: allOf: - $ref: '#/components/schemas/_types.StoreStats' translog: allOf: - $ref: '#/components/schemas/_types.TranslogStats' warmer: allOf: - $ref: '#/components/schemas/_types.WarmerStats' bulk: allOf: - $ref: '#/components/schemas/_types.BulkStats' shards: x-state: Generally available; Added in 7.15.0 type: object additionalProperties: type: object shard_stats: allOf: - $ref: '#/components/schemas/indices.stats.ShardsTotalStats' indices: type: object additionalProperties: $ref: '#/components/schemas/indices.stats.ShardStats' _types.mapping.TokenCountProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: analyzer: type: string boost: type: number index: type: boolean null_value: type: number enable_position_increments: type: boolean type: type: string enum: - token_count required: - type _types.aggregations.MovingAverageAggregationBase: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object properties: minimize: type: boolean predict: type: number window: type: number _types.Ids: oneOf: - $ref: '#/components/schemas/_types.Id' - type: array items: $ref: '#/components/schemas/_types.Id' _types.query_dsl.RegexpQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: case_insensitive: description: 'Allows case insensitive matching of the regular expression value with the indexed field values when set to `true`. When `false`, case sensitivity of matching depends on the underlying field’s mapping.' default: false x-state: Generally available; Added in 7.10.0 type: boolean flags: description: Enables optional operators for the regular expression. type: string max_determinized_states: description: Maximum number of automaton states required for the query. default: 10000.0 type: number rewrite: description: Method used to rewrite the query. allOf: - $ref: '#/components/schemas/_types.MultiTermQueryRewrite' value: description: Regular expression for terms you wish to find in the provided field. type: string required: - value _types.aggregations.FieldDateMath: description: 'A date range limit, represented either as a DateMath expression or a number expressed according to the target field''s precision.' oneOf: - $ref: '#/components/schemas/_types.DateMath' - type: number _types.DiversifyRetrieverTypes: type: string enum: - mmr _types.analysis.FingerprintAnalyzer: type: object properties: type: type: string enum: - fingerprint version: deprecated: true allOf: - $ref: '#/components/schemas/_types.VersionString' max_output_size: description: 'The maximum token size to emit. Tokens larger than this size will be discarded. Defaults to `255`' default: 255.0 type: number separator: description: 'The character to use to concatenate the terms. Defaults to a space.' type: string stopwords: description: 'A pre-defined stop words list like `_english_` or an array containing a list of stop words. Defaults to `_none_`.' default: _none_ allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: description: The path to a file containing stop words. type: string required: - type _types.Metadata: type: object additionalProperties: type: object _types.aggregations.AverageAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase' - type: object _types.GeoDistanceType: type: string enum: - arc - plane _types.TokenPruningConfig: type: object properties: tokens_freq_ratio_threshold: description: Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned. default: 5.0 type: number tokens_weight_threshold: description: Tokens whose weight is less than this threshold are considered nonsignificant and pruned. default: 0.4 type: number only_score_pruned_tokens: description: Whether to only score pruned tokens, vs only scoring kept tokens. default: false type: boolean _types.TopRightBottomLeftGeoBounds: type: object properties: top_right: allOf: - $ref: '#/components/schemas/_types.GeoLocation' bottom_left: allOf: - $ref: '#/components/schemas/_types.GeoLocation' required: - top_right - bottom_left indices._types.NumericFielddataFormat: type: string enum: - array - disabled indices.segments.ShardsSegment: type: object properties: num_committed_segments: type: number routing: allOf: - $ref: '#/components/schemas/indices.segments.ShardSegmentRouting' num_search_segments: type: number segments: type: object additionalProperties: $ref: '#/components/schemas/indices.segments.Segment' required: - num_committed_segments - routing - num_search_segments - segments cluster._types.ComponentTemplateSummaryRes: type: object properties: lifecycle: x-state: Generally available; Added in 8.11.0 allOf: - $ref: '#/components/schemas/indices._types.DataStreamLifecycleWithRollover' _meta: allOf: - $ref: '#/components/schemas/_types.Metadata' version: allOf: - $ref: '#/components/schemas/_types.VersionNumber' settings: type: object additionalProperties: $ref: '#/components/schemas/indices._types.IndexSettings' mappings: allOf: - $ref: '#/components/schemas/_types.mapping.TypeMapping' aliases: type: object additionalProperties: $ref: '#/components/schemas/indices._types.AliasDefinition' data_stream_options: x-state: Generally available; Added in 8.19.0 allOf: - $ref: '#/components/schemas/indices._types.DataStreamOptions' indices._types.DataStreamLifecycleRolloverConditions: type: object properties: min_age: allOf: - $ref: '#/components/schemas/_types.Duration' max_age: type: string min_docs: type: number max_docs: type: number min_size: allOf: - $ref: '#/components/schemas/_types.ByteSize' max_size: allOf: - $ref: '#/components/schemas/_types.ByteSize' min_primary_shard_size: allOf: - $ref: '#/components/schemas/_types.ByteSize' max_primary_shard_size: allOf: - $ref: '#/components/schemas/_types.ByteSize' min_primary_shard_docs: type: number max_primary_shard_docs: type: number indices._types.DataStreamLifecycle: description: Data stream lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration. type: object properties: data_retention: description: 'If defined, every document added to this data stream will be stored at least for this time frame. Any time after this duration the document could be deleted. When empty, every document in this data stream will be stored indefinitely.' allOf: - $ref: '#/components/schemas/_types.Duration' effective_retention: description: The least amount of time data should be kept by elasticsearch. allOf: - $ref: '#/components/schemas/_types.Duration' retention_determined_by: description: Configuration source that can influence the retention of a data stream. allOf: - $ref: '#/components/schemas/indices._types.RetentionSource' downsampling: description: The list of downsampling rounds to execute as part of this downsampling configuration type: array items: $ref: '#/components/schemas/indices._types.DownsamplingRound' downsampling_method: description: 'The method used to downsample the data. There are two options `aggregate` and `last_value`. It requires `downsampling` to be defined. Defaults to `aggregate`.' allOf: - $ref: '#/components/schemas/indices._types.SamplingMethod' enabled: description: 'If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle that''s disabled (enabled: `false`) will have no effect on the data stream.' default: true type: boolean frozen_after: description: 'The period after which data stream backing indices are automatically converted to partially mounted searchable snapshots. This field is valid only on main data stream lifecycles and cannot be set on failure-store lifecycles.' x-state: Generally available; Added in 9.5.0 allOf: - $ref: '#/components/schemas/_types.Duration' indices._types.SettingsSimilarityLmj: type: object properties: type: type: string enum: - LMJelinekMercer lambda: type: number required: - type _types.query_dsl.QueryBase: type: object properties: boost: description: 'Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.' default: 1.0 type: number _name: type: string _types.analysis.PhoneticLanguage: type: string enum: - any - common - cyrillic - english - french - german - hebrew - hungarian - polish - romanian - russian - spanish _types.query_dsl.PercolateQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: document: description: The source of the document being percolated. type: object documents: description: An array of sources of the documents being percolated. type: array items: type: object field: description: Field that holds the indexed queries. The field must use the `percolator` mapping type. allOf: - $ref: '#/components/schemas/_types.Field' id: description: The ID of a stored document to percolate. allOf: - $ref: '#/components/schemas/_types.Id' index: description: The index of a stored document to percolate. allOf: - $ref: '#/components/schemas/_types.IndexName' name: description: The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified. type: string preference: description: Preference used to fetch document to percolate. type: string routing: description: Routing used to fetch document to percolate. type: string version: description: The expected version of a stored document to percolate. allOf: - $ref: '#/components/schemas/_types.VersionNumber' required: - field _types.query_dsl.IntervalsWildcard: type: object properties: analyzer: description: 'Analyzer used to analyze the `pattern`. Defaults to the top-level field''s analyzer.' type: string pattern: description: Wildcard pattern used to find matching terms. type: string use_field: description: 'If specified, match intervals from this field rather than the top-level field. The `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.' allOf: - $ref: '#/components/schemas/_types.Field' required: - pattern _types.aggregations.TermsExclude: oneOf: - type: string - type: array items: type: string _types.mapping.HistogramProperty: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: ignore_malformed: type: boolean time_series_metric: allOf: - $ref: '#/components/schemas/_types.mapping.TimeSeriesMetricType' type: type: string enum: - histogram required: - type indices.stats.IndicesStats: type: object properties: primaries: allOf: - $ref: '#/components/schemas/indices.stats.IndexStats' shards: type: object additionalProperties: type: array items: $ref: '#/components/schemas/indices.stats.ShardStats' total: allOf: - $ref: '#/components/schemas/indices.stats.IndexStats' uuid: allOf: - $ref: '#/components/schemas/_types.Uuid' health: x-state: Generally available; Added in 8.1.0 allOf: - $ref: '#/components/schemas/_types.HealthStatus' status: x-state: Generally available; Added in 8.1.0 allOf: - $ref: '#/components/schemas/indices.stats.IndexMetadataState' _types.SequenceNumber: type: number _types.query_dsl.WrapperQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: query: description: 'A base64 encoded query. The binary data format can be any of JSON, YAML, CBOR or SMILE encodings' type: string required: - query _types.query_dsl.FieldValueFactorScoreFunction: type: object properties: field: description: Field to be extracted from the document. allOf: - $ref: '#/components/schemas/_types.Field' factor: description: Optional factor to multiply the field value with. default: 1.0 type: number missing: description: 'Value used if the document doesn’t have that field. The modifier and factor are still applied to it as though it were read from the document.' type: number modifier: description: Modifier to apply to the field value. allOf: - $ref: '#/components/schemas/_types.query_dsl.FieldValueFactorModifier' required: - field _types.analysis.PatternTokenizer: allOf: - $ref: '#/components/schemas/_types.analysis.TokenizerBase' - type: object properties: type: type: string enum: - pattern flags: type: string group: type: number pattern: type: string required: - type _types.aggregations.TermsAggregationExecutionHint: type: string enum: - map - global_ordinals - global_ordinals_hash - global_ordinals_low_cardinality _types.analysis.NoriPartOfSpeechTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - nori_part_of_speech stoptags: description: An array of part-of-speech tags that should be removed. type: array items: type: string required: - type _types.analysis.RomanianAnalyzer: type: object properties: type: type: string enum: - romanian stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type indices.recovery.RecoveryFiles: type: object properties: details: type: array items: $ref: '#/components/schemas/indices.recovery.FileDetails' percent: allOf: - $ref: '#/components/schemas/_types.Percentage' recovered: type: number reused: type: number total: type: number required: - percent - recovered - reused - total indices.close.CloseShardResult: type: object properties: failures: type: array items: $ref: '#/components/schemas/_types.ShardFailure' required: - failures _types.analysis.CzechAnalyzer: type: object properties: type: type: string enum: - czech stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type indices._types.FailureStoreLifecycle: description: The failure store lifecycle configures the data stream lifecycle configuration for failure indices. type: object properties: data_retention: description: 'If defined, every document added to this data stream will be stored at least for this time frame. Any time after this duration the document could be deleted. When empty, every document in this data stream will be stored indefinitely.' allOf: - $ref: '#/components/schemas/_types.Duration' enabled: description: 'If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle that''s disabled (enabled: `false`) will have no effect on the data stream.' default: true type: boolean indices._types.FailureStoreLifecycleTemplate: description: Template equivalent of FailureStoreLifecycle that allows nullable values. type: object properties: data_retention: description: 'If defined, every document added to this data stream will be stored at least for this time frame. Any time after this duration the document could be deleted. When empty, every document in this data stream will be stored indefinitely.' oneOf: - $ref: '#/components/schemas/_types.Duration' - type: - string - 'null' enabled: description: 'If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle that''s disabled (enabled: `false`) will have no effect on the data stream.' default: true type: boolean _types.analysis.TokenizerBase: type: object properties: version: allOf: - $ref: '#/components/schemas/_types.VersionString' _types.aggregations.SerialDifferencingAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object properties: lag: description: 'The historical bucket to subtract from the current value. Must be a positive, non-zero integer.' type: number _types.TranslogStats: type: object properties: earliest_last_modified_age: type: number operations: type: number size: type: string size_in_bytes: type: number uncommitted_operations: type: number uncommitted_size: type: string uncommitted_size_in_bytes: type: number required: - earliest_last_modified_age - operations - size_in_bytes - uncommitted_operations - uncommitted_size_in_bytes _types.query_dsl.QueryContainer: externalDocs: url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl description: An Elasticsearch Query DSL (Domain Specific Language) object that defines a query. type: object properties: bool: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-bool-query description: matches documents matching boolean combinations of other queries. allOf: - $ref: '#/components/schemas/_types.query_dsl.BoolQuery' boosting: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-boosting-query description: Returns documents matching a `positive` query while reducing the relevance score of documents that also match a `negative` query. allOf: - $ref: '#/components/schemas/_types.query_dsl.BoostingQuery' common: deprecated: true type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.CommonTermsQuery' minProperties: 1 maxProperties: 1 combined_fields: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-combined-fields-query description: The `combined_fields` query supports searching multiple text fields as if their contents had been indexed into one combined field. x-state: Generally available; Added in 7.13.0 allOf: - $ref: '#/components/schemas/_types.query_dsl.CombinedFieldsQuery' constant_score: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-constant-score-query description: Wraps a filter query and returns every matching document with a relevance score equal to the `boost` parameter value. allOf: - $ref: '#/components/schemas/_types.query_dsl.ConstantScoreQuery' dis_max: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-dis-max-query description: 'Returns documents matching one or more wrapped queries, called query clauses or clauses. If a returned document matches multiple query clauses, the `dis_max` query assigns the document the highest relevance score from any matching clause, plus a tie breaking increment for any additional matching subqueries.' allOf: - $ref: '#/components/schemas/_types.query_dsl.DisMaxQuery' distance_feature: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-distance-feature-query description: 'Boosts the relevance score of documents closer to a provided origin date or point. For example, you can use this query to give more weight to documents closer to a certain date or location.' allOf: - $ref: '#/components/schemas/_types.query_dsl.DistanceFeatureQuery' exists: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-exists-query description: Returns documents that contain an indexed value for a field. allOf: - $ref: '#/components/schemas/_types.query_dsl.ExistsQuery' function_score: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-function-score-query description: The `function_score` enables you to modify the score of documents that are retrieved by a query. allOf: - $ref: '#/components/schemas/_types.query_dsl.FunctionScoreQuery' fuzzy: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-fuzzy-query description: Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance. type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.FuzzyQuery' minProperties: 1 maxProperties: 1 geo_bounding_box: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-bounding-box-query description: Matches geo_point and geo_shape values that intersect a bounding box. allOf: - $ref: '#/components/schemas/_types.query_dsl.GeoBoundingBoxQuery' geo_distance: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-distance-query description: Matches `geo_point` and `geo_shape` values within a given distance of a geopoint. allOf: - $ref: '#/components/schemas/_types.query_dsl.GeoDistanceQuery' geo_grid: description: Matches `geo_point` and `geo_shape` values that intersect a grid cell from a GeoGrid aggregation. type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.GeoGridQuery' minProperties: 1 maxProperties: 1 geo_polygon: deprecated: true allOf: - $ref: '#/components/schemas/_types.query_dsl.GeoPolygonQuery' geo_shape: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-shape-query description: Filter documents indexed using either the `geo_shape` or the `geo_point` type. allOf: - $ref: '#/components/schemas/_types.query_dsl.GeoShapeQuery' has_child: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-has-child-query description: Returns parent documents whose joined child documents match a provided query. allOf: - $ref: '#/components/schemas/_types.query_dsl.HasChildQuery' has_parent: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-has-parent-query description: Returns child documents whose joined parent document matches a provided query. allOf: - $ref: '#/components/schemas/_types.query_dsl.HasParentQuery' ids: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-ids-query description: 'Returns documents based on their IDs. This query uses document IDs stored in the `_id` field.' allOf: - $ref: '#/components/schemas/_types.query_dsl.IdsQuery' intervals: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-intervals-query description: Returns documents based on the order and proximity of matching terms. type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.IntervalsQuery' minProperties: 1 maxProperties: 1 knn: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-knn-query description: 'Finds the k nearest vectors to a query vector, as measured by a similarity metric. knn query finds nearest vectors through approximate search on indexed dense_vectors.' allOf: - $ref: '#/components/schemas/_types.KnnQuery' match: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query description: 'Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching.' type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.MatchQuery' minProperties: 1 maxProperties: 1 match_all: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query description: Matches all documents, giving them all a `_score` of 1.0. allOf: - $ref: '#/components/schemas/_types.query_dsl.MatchAllQuery' match_bool_prefix: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-bool-prefix-query description: 'Analyzes its input and constructs a `bool` query from the terms. Each term except the last is used in a `term` query. The last term is used in a prefix query.' type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.MatchBoolPrefixQuery' minProperties: 1 maxProperties: 1 match_none: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query#query-dsl-match-none-query description: Matches no documents. allOf: - $ref: '#/components/schemas/_types.query_dsl.MatchNoneQuery' match_phrase: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase description: Analyzes the text and creates a phrase query out of the analyzed text. type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.MatchPhraseQuery' minProperties: 1 maxProperties: 1 match_phrase_prefix: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase-prefix description: 'Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.' type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.MatchPhrasePrefixQuery' minProperties: 1 maxProperties: 1 more_like_this: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-mlt-query description: Returns documents that are "like" a given set of documents. allOf: - $ref: '#/components/schemas/_types.query_dsl.MoreLikeThisQuery' multi_match: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-match-query description: 'Enables you to search for a provided text, number, date or boolean value across multiple fields. The provided text is analyzed before matching.' allOf: - $ref: '#/components/schemas/_types.query_dsl.MultiMatchQuery' nested: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-nested-query description: 'Wraps another query to search nested fields. If an object matches the search, the nested query returns the root parent document.' allOf: - $ref: '#/components/schemas/_types.query_dsl.NestedQuery' parent_id: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-parent-id-query description: Returns child documents joined to a specific parent document. allOf: - $ref: '#/components/schemas/_types.query_dsl.ParentIdQuery' percolate: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-percolate-query description: Matches queries stored in an index. allOf: - $ref: '#/components/schemas/_types.query_dsl.PercolateQuery' pinned: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-pinned-query description: Promotes selected documents to rank higher than those matching a given query. allOf: - $ref: '#/components/schemas/_types.query_dsl.PinnedQuery' prefix: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-prefix-query description: Returns documents that contain a specific prefix in a provided field. type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.PrefixQuery' minProperties: 1 maxProperties: 1 query_string: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-query-string-query description: Returns documents based on a provided query string, using a parser with a strict syntax. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryStringQuery' range: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-range-query description: Returns documents that contain terms within a provided range. type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.RangeQuery' minProperties: 1 maxProperties: 1 rank_feature: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-rank-feature-query description: Boosts the relevance score of documents based on the numeric value of a `rank_feature` or `rank_features` field. allOf: - $ref: '#/components/schemas/_types.query_dsl.RankFeatureQuery' regexp: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-regexp-query description: Returns documents that contain terms matching a regular expression. type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.RegexpQuery' minProperties: 1 maxProperties: 1 rule: allOf: - $ref: '#/components/schemas/_types.query_dsl.RuleQuery' script: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-script-query description: 'Filters documents based on a provided script. The script query is typically used in a filter context.' allOf: - $ref: '#/components/schemas/_types.query_dsl.ScriptQuery' script_score: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-script-score-query description: Uses a script to provide a custom score for returned documents. allOf: - $ref: '#/components/schemas/_types.query_dsl.ScriptScoreQuery' semantic: description: A semantic query to semantic_text field types x-state: Generally available; Added in 8.15.0 allOf: - $ref: '#/components/schemas/_types.query_dsl.SemanticQuery' shape: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-shape-query description: Queries documents that contain fields indexed using the `shape` type. allOf: - $ref: '#/components/schemas/_types.query_dsl.ShapeQuery' simple_query_string: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-simple-query-string-query description: Returns documents based on a provided query string, using a parser with a limited but fault-tolerant syntax. allOf: - $ref: '#/components/schemas/_types.query_dsl.SimpleQueryStringQuery' span_containing: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-containing-query description: Returns matches which enclose another span query. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanContainingQuery' span_field_masking: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-field-masking-query description: Wrapper to allow span queries to participate in composite single-field span queries by _lying_ about their search field. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanFieldMaskingQuery' span_first: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-first-query description: Matches spans near the beginning of a field. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanFirstQuery' span_multi: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-multi-term-query description: Allows you to wrap a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query) as a `span` query, so it can be nested. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanMultiTermQuery' span_near: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-near-query description: 'Matches spans which are near one another. You can specify `slop`, the maximum number of intervening unmatched positions, as well as whether matches are required to be in-order.' allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanNearQuery' span_not: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-not-query description: Removes matches which overlap with another span query or which are within x tokens before (controlled by the parameter `pre`) or y tokens after (controlled by the parameter `post`) another span query. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanNotQuery' span_or: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-query description: Matches the union of its span clauses. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanOrQuery' span_term: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-term-query description: Matches spans containing a term. type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.SpanTermQuery' minProperties: 1 maxProperties: 1 span_within: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-within-query description: Returns matches which are enclosed inside another span query. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanWithinQuery' sparse_vector: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-sparse-vector-query description: Using input query vectors or a natural language processing model to convert a query into a list of token-weight pairs, queries against a sparse vector field. x-state: Generally available; Added in 8.15.0 allOf: - $ref: '#/components/schemas/_types.query_dsl.SparseVectorQuery' term: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-term-query description: 'Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field''s value, including whitespace and capitalization.' type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.TermQuery' minProperties: 1 maxProperties: 1 terms: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-query description: 'Returns documents that contain one or more exact terms in a provided field. To return a document, one or more terms must exactly match a field value, including whitespace and capitalization.' allOf: - $ref: '#/components/schemas/_types.query_dsl.TermsQuery' terms_set: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-set-query description: 'Returns documents that contain a minimum number of exact terms in a provided field. To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.' type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.TermsSetQuery' minProperties: 1 maxProperties: 1 text_expansion: deprecated: true externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-text-expansion-query description: Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field. x-state: Generally available; Added in 8.8.0 type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.TextExpansionQuery' minProperties: 1 maxProperties: 1 weighted_tokens: deprecated: true externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-weighted-tokens-query description: Supports returning text_expansion query results by sending in precomputed tokens with the query. x-state: Generally available; Added in 8.13.0 type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.WeightedTokensQuery' minProperties: 1 maxProperties: 1 wildcard: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wildcard-query description: Returns documents that contain terms matching a wildcard pattern. type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.WildcardQuery' minProperties: 1 maxProperties: 1 wrapper: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wrapper-query description: A query that accepts any other query as base64 encoded string. allOf: - $ref: '#/components/schemas/_types.query_dsl.WrapperQuery' type: deprecated: true allOf: - $ref: '#/components/schemas/_types.query_dsl.TypeQuery' minProperties: 1 maxProperties: 1 _types.mapping.ConstantKeywordProperty: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: value: type: object type: type: string enum: - constant_keyword required: - type _types.analysis.HindiNormalizationTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - hindi_normalization required: - type _types.aggregations.MinimumInterval: type: string enum: - second - minute - hour - day - month - year _types.ScoreSort: type: object properties: order: allOf: - $ref: '#/components/schemas/_types.SortOrder' indices._types.MappingLimitSettingsDepth: type: object properties: limit: description: 'The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined at the root object level, then the depth is 1. If there is one object mapping, then the depth is 2, etc.' default: 20.0 type: number _types.IndexAlias: type: string _types.aggregations.BucketSortAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.Aggregation' - type: object properties: from: description: Buckets in positions prior to `from` will be truncated. type: number gap_policy: description: The policy to apply when gaps are found in the data. default: skip allOf: - $ref: '#/components/schemas/_types.aggregations.GapPolicy' size: description: 'The number of buckets to return. Defaults to all buckets of the parent aggregation.' type: number sort: description: The list of fields to sort on. allOf: - $ref: '#/components/schemas/_types.Sort' _types.query_dsl.CommonTermsQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: analyzer: type: string cutoff_frequency: type: number high_freq_operator: allOf: - $ref: '#/components/schemas/_types.query_dsl.Operator' low_freq_operator: allOf: - $ref: '#/components/schemas/_types.query_dsl.Operator' minimum_should_match: allOf: - $ref: '#/components/schemas/_types.MinimumShouldMatch' query: type: string required: - query _types.mapping.FieldMapping: type: object properties: full_name: type: string mapping: type: object additionalProperties: $ref: '#/components/schemas/_types.mapping.Property' minProperties: 1 maxProperties: 1 required: - full_name - mapping _spec_utils.PipeSeparatedFlagsSimpleQueryStringFlag: description: 'A set of flags that can be represented as a single enum value or a set of values that are encoded as a pipe-separated string Depending on the target language, code generators can use this hint to generate language specific flags enum constructs and the corresponding (de-)serialization code.' oneOf: - $ref: '#/components/schemas/_types.query_dsl.SimpleQueryStringFlag' - type: string _types.KnnQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: field: description: The name of the vector field to search against allOf: - $ref: '#/components/schemas/_types.Field' query_vector: description: The query vector allOf: - $ref: '#/components/schemas/_types.QueryVector' query_vector_builder: description: The query vector builder. You must provide a query_vector_builder or query_vector, but not both. allOf: - $ref: '#/components/schemas/_types.QueryVectorBuilder' num_candidates: description: The number of nearest neighbor candidates to consider per shard type: number visit_percentage: description: The percentage of vectors to explore per shard while doing knn search with bbq_disk x-state: Generally available; Added in 9.2.0 type: number k: description: The final number of nearest neighbors to return as top hits type: number filter: description: Filters for the kNN search query oneOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' - type: array items: $ref: '#/components/schemas/_types.query_dsl.QueryContainer' similarity: description: The minimum similarity for a vector to be considered a match type: number rescore_vector: description: Apply oversampling and rescoring to quantized vectors x-state: Generally available; Added in 8.18.0 allOf: - $ref: '#/components/schemas/_types.RescoreVector' required: - field _types.Fuzziness: oneOf: - type: string - type: number _types.analysis.JaStopTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - ja_stop stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' required: - type _types.EmptyObject: description: For empty Class assignments type: object _types.SortMode: type: string enum: - min - max - sum - avg - median _types.query_dsl.PinnedDoc: type: object properties: _id: description: The unique document ID. allOf: - $ref: '#/components/schemas/_types.Id' _index: description: The index that contains the document. allOf: - $ref: '#/components/schemas/_types.IndexName' required: - _id indices._types.StorageType: anyOf: - type: string enum: - fs - niofs - mmapfs - hybridfs - type: string _types.RequestCacheStats: type: object properties: evictions: type: number hit_count: type: number memory_size: type: string memory_size_in_bytes: type: number miss_count: type: number required: - evictions - hit_count - memory_size_in_bytes - miss_count _types.analysis.ArabicStemTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - arabic_stem required: - type _global.search._types.Rescore: allOf: - type: object properties: window_size: type: number - type: object properties: query: allOf: - $ref: '#/components/schemas/_global.search._types.RescoreQuery' learning_to_rank: allOf: - $ref: '#/components/schemas/_global.search._types.LearningToRank' script: allOf: - $ref: '#/components/schemas/_global.search._types.ScriptRescore' minProperties: 1 maxProperties: 1 _types.QueryVector: type: array items: type: number _types.aggregations.BucketsQueryContainer: description: 'Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.' oneOf: - type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.QueryContainer' - type: array items: $ref: '#/components/schemas/_types.query_dsl.QueryContainer' _types.mapping.MatchOnlyTextProperty: description: 'A variant of text that trades scoring and efficiency of positional queries for space efficiency. This field effectively stores data the same way as a text field that only indexes documents (index_options: docs) and disables norms (norms: false). Term queries perform as fast if not faster as on text fields, however queries that need positions such as the match_phrase query perform slower as they need to look at the _source document to verify whether a phrase matches. All queries return constant scores that are equal to 1.0.' type: object properties: type: type: string enum: - match_only_text fields: description: 'Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one field for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers.' type: object additionalProperties: $ref: '#/components/schemas/_types.mapping.Property' meta: description: Metadata about the field. type: object additionalProperties: type: string copy_to: description: 'Allows you to copy the values of multiple fields into a group field, which can then be queried as a single field.' allOf: - $ref: '#/components/schemas/_types.Fields' required: - type _types.query_dsl.DistanceFeatureQueryBase: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: origin: description: 'Date or point of origin used to calculate distances. If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date. Date Math, such as `now-1h`, is supported. If the field value is a `geo_point` field, the `origin` value must be a geopoint.' type: object pivot: description: 'Distance from the `origin` at which relevance scores receive half of the `boost` value. If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`.' type: object field: description: 'Name of the field used to calculate distances. This field must meet the following criteria: be a `date`, `date_nanos` or `geo_point` field; have an `index` mapping parameter value of `true`, which is the default; have an `doc_values` mapping parameter value of `true`, which is the default.' allOf: - $ref: '#/components/schemas/_types.Field' required: - origin - pivot - field _types.Name: type: string _types.aggregations.SumBucketAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object _types.aggregations.Missing: oneOf: - type: string - type: number - type: number - type: boolean _types.aggregations.DateHistogramAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: calendar_interval: description: 'Calendar-aware interval. Can be specified using the unit name, such as `month`, or as a single unit quantity, such as `1M`.' allOf: - $ref: '#/components/schemas/_types.aggregations.CalendarInterval' extended_bounds: description: Enables extending the bounds of the histogram beyond the data itself. allOf: - $ref: '#/components/schemas/_types.aggregations.ExtendedBoundsFieldDateMath' hard_bounds: description: Limits the histogram to specified bounds. allOf: - $ref: '#/components/schemas/_types.aggregations.ExtendedBoundsFieldDateMath' field: description: The date field whose values are use to build a histogram. allOf: - $ref: '#/components/schemas/_types.Field' fixed_interval: description: 'Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar.' allOf: - $ref: '#/components/schemas/_types.Duration' format: description: 'The date format used to format `key_as_string` in the response. If no `format` is specified, the first date format specified in the field mapping is used.' type: string interval: deprecated: true allOf: - $ref: '#/components/schemas/_types.Duration' min_doc_count: description: 'Only returns buckets that have `min_doc_count` number of documents. By default, all buckets between the first bucket that matches documents and the last one are returned.' type: number missing: description: 'The value to apply to documents that do not have a value. By default, documents without a value are ignored.' allOf: - $ref: '#/components/schemas/_types.DateTime' offset: description: Changes the start value of each bucket by the specified positive (`+`) or negative offset (`-`) duration. allOf: - $ref: '#/components/schemas/_types.Duration' order: description: The sort order of the returned buckets. allOf: - $ref: '#/components/schemas/_types.aggregations.AggregateOrder' params: type: object additionalProperties: type: object script: allOf: - $ref: '#/components/schemas/_types.Script' time_zone: description: 'Time zone used for bucketing and rounding. Defaults to Coordinated Universal Time (UTC).' allOf: - $ref: '#/components/schemas/_types.TimeZone' keyed: description: Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array. type: boolean _types.mapping.DocValuesConfig: description: Configuration object for doc values when sub-parameters are needed. type: object properties: multi_value: description: 'If `false`, the field is treated as single-valued, enabling optimized storage. Only has an effect when columnar index mode is active.' default: true x-state: Experimental type: boolean nullability: description: 'If `false`, every document must provide a non-null value for the field: a document that omits the field, sets it to `null`, or supplies only null values (an empty array or an all-null array) is rejected at index time. A field that defines `null_value` is always exempt, since the configured default removes the absence of a value. Only has an effect when columnar index mode is active.' default: true x-state: Experimental type: boolean _types.query_dsl.RangeQueryBasedouble: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: relation: description: Indicates how the range query matches values for `range` fields. default: intersects allOf: - $ref: '#/components/schemas/_types.query_dsl.RangeRelation' gt: description: Greater than. type: number gte: description: Greater than or equal to. type: number lt: description: Less than. type: number lte: description: Less than or equal to. type: number indices._types.MappingLimitSettingsDimensionFields: type: object properties: limit: description: '[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.' type: number _types.query_dsl.IdsQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: values: description: An array of document IDs. allOf: - $ref: '#/components/schemas/_types.Ids' _types.query_dsl.BoostingQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: negative_boost: description: Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the `negative` query. type: number negative: description: Query used to decrease the relevance score of matching documents. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' positive: description: Any returned documents must match this query. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' required: - negative_boost - negative - positive _global.search._types.HighlighterEncoder: type: string enum: - default - html _types.query_dsl.QueryStringQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: allow_leading_wildcard: description: If `true`, the wildcard characters `*` and `?` are allowed as the first character of the query string. default: true type: boolean analyzer: description: Analyzer used to convert text in the query string into tokens. type: string analyze_wildcard: description: If `true`, the query attempts to analyze wildcard terms in the query string. default: false type: boolean auto_generate_synonyms_phrase_query: description: If `true`, match phrase queries are automatically created for multi-term synonyms. default: true type: boolean default_field: description: 'Default field to search if no field is provided in the query string. Supports wildcards (`*`). Defaults to the `index.query.default_field` index setting, which has a default value of `*`.' allOf: - $ref: '#/components/schemas/_types.Field' default_operator: description: Default boolean logic used to interpret text in the query string if no operators are specified. default: '''or''' allOf: - $ref: '#/components/schemas/_types.query_dsl.Operator' enable_position_increments: description: If `true`, enable position increments in queries constructed from a `query_string` search. default: true type: boolean escape: default: false type: boolean fields: description: Array of fields to search. Supports wildcards (`*`). type: array items: $ref: '#/components/schemas/_types.Field' fuzziness: description: Maximum edit distance allowed for fuzzy matching. allOf: - $ref: '#/components/schemas/_types.Fuzziness' fuzzy_max_expansions: description: Maximum number of terms to which the query expands for fuzzy matching. default: 50.0 type: number fuzzy_prefix_length: description: Number of beginning characters left unchanged for fuzzy matching. default: 0.0 type: number fuzzy_rewrite: description: Method used to rewrite the query. allOf: - $ref: '#/components/schemas/_types.MultiTermQueryRewrite' fuzzy_transpositions: description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). default: true type: boolean lenient: description: If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. default: false type: boolean max_determinized_states: description: Maximum number of automaton states required for the query. default: 10000.0 type: number minimum_should_match: description: Minimum number of clauses that must match for a document to be returned. allOf: - $ref: '#/components/schemas/_types.MinimumShouldMatch' phrase_slop: description: Maximum number of positions allowed between matching tokens for phrases. default: 0.0 type: number query: description: Query string you wish to parse and use for search. type: string quote_analyzer: description: 'Analyzer used to convert quoted text in the query string into tokens. For quoted text, this parameter overrides the analyzer specified in the `analyzer` parameter.' type: string quote_field_suffix: description: 'Suffix appended to quoted text in the query string. You can use this suffix to use a different analysis method for exact matches.' type: string rewrite: description: Method used to rewrite the query. allOf: - $ref: '#/components/schemas/_types.MultiTermQueryRewrite' tie_breaker: description: How to combine the queries generated from the individual search terms in the resulting `dis_max` query. type: number time_zone: description: Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC. allOf: - $ref: '#/components/schemas/_types.TimeZone' type: description: Determines how the query matches and scores documents. default: '''best_fields''' allOf: - $ref: '#/components/schemas/_types.query_dsl.TextQueryType' required: - query indices.get_mapping.IndexMappingRecord: type: object properties: item: allOf: - $ref: '#/components/schemas/_types.mapping.TypeMapping' mappings: allOf: - $ref: '#/components/schemas/_types.mapping.TypeMapping' required: - mappings _types.mapping.SearchAsYouTypeProperty: allOf: - $ref: '#/components/schemas/_types.mapping.CorePropertyBase' - type: object properties: analyzer: type: string index: type: boolean index_options: allOf: - $ref: '#/components/schemas/_types.mapping.IndexOptions' max_shingle_size: type: number norms: type: boolean search_analyzer: type: string search_quote_analyzer: type: string similarity: oneOf: - type: string - type: - string - 'null' term_vector: allOf: - $ref: '#/components/schemas/_types.mapping.TermVectorOption' type: type: string enum: - search_as_you_type required: - type _types.query_dsl.SpanWithinQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: big: description: 'Can be any span query. Matching spans from `little` that are enclosed within `big` are returned.' allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanQuery' little: description: 'Can be any span query. Matching spans from `little` that are enclosed within `big` are returned.' allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanQuery' required: - big - little indices._types.CacheQueries: type: object properties: enabled: type: boolean required: - enabled _types.GlobalOrdinalFieldStats: type: object properties: build_time_in_millis: allOf: - $ref: '#/components/schemas/_types.UnitMillis' build_time: type: string shard_max_value_count: type: number required: - build_time_in_millis - shard_max_value_count _types.MultiTermQueryRewrite: type: string _types.analysis.RussianStemTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - russian_stem required: - type _types.aggregations.WeightedAverageValue: type: object properties: field: description: The field from which to extract the values or weights. allOf: - $ref: '#/components/schemas/_types.Field' missing: description: A value or weight to use if the field is missing. type: number script: allOf: - $ref: '#/components/schemas/_types.Script' indices._types.MergeScheduler: type: object properties: max_thread_count: allOf: - $ref: '#/components/schemas/_spec_utils.Stringifiedinteger' max_merge_count: allOf: - $ref: '#/components/schemas/_spec_utils.Stringifiedinteger' _types.query_dsl.IntervalsRegexp: type: object properties: analyzer: description: Analyzer used to analyze the `prefix`. type: string pattern: description: Regex pattern. type: string use_field: description: 'If specified, match intervals from this field rather than the top-level field. The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.' allOf: - $ref: '#/components/schemas/_types.Field' required: - pattern _types.analysis.KeywordAnalyzer: type: object properties: type: type: string enum: - keyword version: deprecated: true allOf: - $ref: '#/components/schemas/_types.VersionString' required: - type _types.TransportAddress: type: string _types.query_dsl.DecayFunctionBaseDateMathDuration: type: object properties: multi_value_mode: description: Determines how the distance is calculated when a field used for computing the decay contains multiple values. default: min allOf: - $ref: '#/components/schemas/_types.query_dsl.MultiValueMode' indices._types.IndexingPressure: type: object properties: memory: allOf: - $ref: '#/components/schemas/indices._types.IndexingPressureMemory' required: - memory _types.analysis.KeywordRepeatTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - keyword_repeat required: - type _types.analysis.BrazilianAnalyzer: type: object properties: type: type: string enum: - brazilian stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string required: - type _types.analysis.LowercaseNormalizer: type: object properties: type: type: string enum: - lowercase required: - type _types.analysis.WhitespaceTokenizer: allOf: - $ref: '#/components/schemas/_types.analysis.TokenizerBase' - type: object properties: type: type: string enum: - whitespace max_token_length: type: number required: - type _global.search._types.InnerHits: type: object properties: name: description: 'The name for the particular inner hit definition in the response. Useful when a search request contains multiple inner hits.' allOf: - $ref: '#/components/schemas/_types.Name' size: description: The maximum number of hits to return per `inner_hits`. default: 3.0 type: number from: description: Inner hit starting document offset. default: 0.0 type: number collapse: allOf: - $ref: '#/components/schemas/_global.search._types.FieldCollapse' docvalue_fields: type: array items: $ref: '#/components/schemas/_types.query_dsl.FieldAndFormat' explain: type: boolean highlight: allOf: - $ref: '#/components/schemas/_global.search._types.Highlight' ignore_unmapped: type: boolean script_fields: type: object additionalProperties: $ref: '#/components/schemas/_types.ScriptField' seq_no_primary_term: type: boolean field: type: array items: $ref: '#/components/schemas/_types.Field' fields: type: array items: $ref: '#/components/schemas/_types.query_dsl.FieldAndFormat' sort: description: 'How the inner hits should be sorted per `inner_hits`. By default, inner hits are sorted by score.' allOf: - $ref: '#/components/schemas/_types.Sort' _source: allOf: - $ref: '#/components/schemas/_global.search._types.SourceConfig' stored_fields: allOf: - $ref: '#/components/schemas/_types.Fields' track_scores: default: false type: boolean version: type: boolean _types.query_dsl.SpanQuery: type: object properties: span_containing: description: Accepts a list of span queries, but only returns those spans which also match a second span query. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanContainingQuery' span_field_masking: description: Allows queries like `span_near` or `span_or` across different fields. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanFieldMaskingQuery' span_first: description: Accepts another span query whose matches must appear within the first N positions of the field. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanFirstQuery' span_gap: allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanGapQuery' span_multi: description: Wraps a `term`, `range`, `prefix`, `wildcard`, `regexp`, or `fuzzy` query. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanMultiTermQuery' span_near: description: Accepts multiple span queries whose matches must be within the specified distance of each other, and possibly in the same order. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanNearQuery' span_not: description: Wraps another span query, and excludes any documents which match that query. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanNotQuery' span_or: description: Combines multiple span queries and returns documents which match any of the specified queries. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanOrQuery' span_term: description: The equivalent of the `term` query but for use with other span queries. type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.SpanTermQuery' minProperties: 1 maxProperties: 1 span_within: description: The result from a single span query is returned as long is its span falls within the spans returned by a list of other span queries. allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanWithinQuery' minProperties: 1 maxProperties: 1 indices._types.IndexRoutingAllocationDisk: type: object properties: threshold_enabled: oneOf: - type: boolean - type: string _types.aggregations.TDigestExecutionHint: type: string enum: - default - high_accuracy _global.search._types.RescoreQuery: type: object properties: rescore_query: description: 'The query to use for rescoring. This query is only run on the Top-K results returned by the `query` and `post_filter` phases.' allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' query_weight: description: Relative importance of the original query versus the rescore query. default: 1.0 type: number rescore_query_weight: description: Relative importance of the rescore query versus the original query. default: 1.0 type: number score_mode: description: Determines how scores are combined. default: total allOf: - $ref: '#/components/schemas/_global.search._types.ScoreMode' required: - rescore_query _types.aggregations.MissingOrder: type: string enum: - first - last - default _types.ExpandWildcards: oneOf: - $ref: '#/components/schemas/_types.ExpandWildcard' - type: array items: $ref: '#/components/schemas/_types.ExpandWildcard' _types.ScriptLanguage: anyOf: - type: string enum: - painless - expression - mustache - java - type: string _types.mapping.DynamicTemplate: allOf: - type: object properties: match: oneOf: - type: string - type: array items: type: string path_match: oneOf: - type: string - type: array items: type: string unmatch: oneOf: - type: string - type: array items: type: string path_unmatch: oneOf: - type: string - type: array items: type: string match_mapping_type: oneOf: - type: string - type: array items: type: string unmatch_mapping_type: oneOf: - type: string - type: array items: type: string match_pattern: allOf: - $ref: '#/components/schemas/_types.mapping.MatchType' - type: object properties: mapping: allOf: - $ref: '#/components/schemas/_types.mapping.Property' runtime: allOf: - $ref: '#/components/schemas/_types.mapping.RuntimeField' minProperties: 1 maxProperties: 1 _types.query_dsl.SpanGapQuery: description: Can only be used as a clause in a span_near query. type: object additionalProperties: type: number minProperties: 1 maxProperties: 1 _types.analysis.WordDelimiterTokenFilterBase: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: catenate_all: description: If `true`, the filter produces catenated tokens for chains of alphanumeric characters separated by non-alphabetic delimiters. Defaults to `false`. type: boolean catenate_numbers: description: If `true`, the filter produces catenated tokens for chains of numeric characters separated by non-alphabetic delimiters. Defaults to `false`. type: boolean catenate_words: description: If `true`, the filter produces catenated tokens for chains of alphabetical characters separated by non-alphabetic delimiters. Defaults to `false`. type: boolean generate_number_parts: description: If `true`, the filter includes tokens consisting of only numeric characters in the output. If `false`, the filter excludes these tokens from the output. Defaults to `true`. type: boolean generate_word_parts: description: If `true`, the filter includes tokens consisting of only alphabetical characters in the output. If `false`, the filter excludes these tokens from the output. Defaults to `true`. type: boolean preserve_original: description: If `true`, the filter includes the original version of any split tokens in the output. This original version includes non-alphanumeric delimiters. Defaults to `false`. allOf: - $ref: '#/components/schemas/_spec_utils.Stringifiedboolean' protected_words: description: Array of tokens the filter won’t split. type: array items: type: string protected_words_path: description: 'Path to a file that contains a list of tokens the filter won’t split. This path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each token in the file must be separated by a line break.' type: string split_on_case_change: description: 'If `true`, the filter splits tokens at letter case transitions. For example: camelCase -> [ camel, Case ]. Defaults to `true`.' type: boolean split_on_numerics: description: 'If `true`, the filter splits tokens at letter-number transitions. For example: j2se -> [ j, 2, se ]. Defaults to `true`.' type: boolean stem_english_possessive: description: 'If `true`, the filter removes the English possessive (`''s`) from the end of each token. For example: O''Neil''s -> [ O, Neil ]. Defaults to `true`.' type: boolean type_table: description: Array of custom type mappings for characters. This allows you to map non-alphanumeric characters as numeric or alphanumeric to avoid splitting on those characters. type: array items: type: string type_table_path: description: Path to a file that contains custom type mappings for characters. This allows you to map non-alphanumeric characters as numeric or alphanumeric to avoid splitting on those characters. type: string _types.query_dsl.ExistsQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: field: description: Name of the field you wish to search. allOf: - $ref: '#/components/schemas/_types.Field' required: - field _types.analysis.EnglishAnalyzer: type: object properties: type: type: string enum: - english stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type _types.RankBase: type: object indices.recovery.RecoveryOrigin: type: object properties: hostname: type: string host: allOf: - $ref: '#/components/schemas/_types.Host' transport_address: allOf: - $ref: '#/components/schemas/_types.TransportAddress' id: allOf: - $ref: '#/components/schemas/_types.Id' ip: allOf: - $ref: '#/components/schemas/_types.Ip' name: allOf: - $ref: '#/components/schemas/_types.Name' bootstrap_new_history_uuid: type: boolean repository: allOf: - $ref: '#/components/schemas/_types.Name' snapshot: allOf: - $ref: '#/components/schemas/_types.Name' version: allOf: - $ref: '#/components/schemas/_types.VersionString' restoreUUID: allOf: - $ref: '#/components/schemas/_types.Uuid' index: allOf: - $ref: '#/components/schemas/_types.IndexName' indices.resolve_index.ResolveIndexAliasItem: type: object properties: name: allOf: - $ref: '#/components/schemas/_types.Name' indices: allOf: - $ref: '#/components/schemas/_types.Indices' required: - name - indices _types.analysis.SynonymFormat: type: string enum: - solr - wordnet _types.RetrieverContainer: type: object properties: standard: description: A retriever that replaces the functionality of a traditional query. allOf: - $ref: '#/components/schemas/_types.StandardRetriever' knn: description: A retriever that replaces the functionality of a knn search. allOf: - $ref: '#/components/schemas/_types.KnnRetriever' rrf: description: A retriever that produces top documents from reciprocal rank fusion (RRF). allOf: - $ref: '#/components/schemas/_types.RRFRetriever' text_similarity_reranker: description: A retriever that reranks the top documents based on a reranking model using the InferenceAPI allOf: - $ref: '#/components/schemas/_types.TextSimilarityReranker' rule: description: A retriever that replaces the functionality of a rule query. allOf: - $ref: '#/components/schemas/_types.RuleRetriever' rescorer: description: A retriever that re-scores only the results produced by its child retriever. allOf: - $ref: '#/components/schemas/_types.RescorerRetriever' linear: description: A retriever that supports the combination of different retrievers through a weighted linear combination. allOf: - $ref: '#/components/schemas/_types.LinearRetriever' pinned: description: 'A pinned retriever applies pinned documents to the underlying retriever. This retriever will rewrite to a PinnedQueryBuilder.' allOf: - $ref: '#/components/schemas/_types.PinnedRetriever' diversify: description: A retriever that diversifies the results from its child retriever. allOf: - $ref: '#/components/schemas/_types.DiversifyRetriever' minProperties: 1 maxProperties: 1 _types.analysis.SpanishAnalyzer: type: object properties: type: type: string enum: - spanish stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type _types.VersionString: type: string _types.query_dsl.ParentIdQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: id: description: ID of the parent document. allOf: - $ref: '#/components/schemas/_types.Id' ignore_unmapped: description: Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. default: false type: boolean type: description: Name of the child relationship mapped for the `join` field. allOf: - $ref: '#/components/schemas/_types.RelationName' _types.mapping.SuggestContext: type: object properties: name: allOf: - $ref: '#/components/schemas/_types.Name' path: allOf: - $ref: '#/components/schemas/_types.Field' type: type: string precision: oneOf: - type: number - type: string required: - name - type indices._types.IndexSettingsTimeSeries: type: object properties: end_time: allOf: - $ref: '#/components/schemas/_types.DateTime' start_time: allOf: - $ref: '#/components/schemas/_types.DateTime' temporality_field: description: 'The name of the field that stores the temporality of a metric. The referenced field must be a `keyword` dimension field; if the setting is unset or the field is missing or invalid, the metric temporality resolves to null.' x-state: Generally available; Added in 9.4.0 allOf: - $ref: '#/components/schemas/_types.Field' _types.analysis.FrenchStemTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - french_stem required: - type _types.ElasticsearchVersionMinInfo: description: Reduced (minimal) info ElasticsearchVersion type: object properties: build_flavor: type: string minimum_index_compatibility_version: allOf: - $ref: '#/components/schemas/_types.VersionString' minimum_wire_compatibility_version: allOf: - $ref: '#/components/schemas/_types.VersionString' number: type: string required: - build_flavor - minimum_index_compatibility_version - minimum_wire_compatibility_version - number _types.analysis.KeepTypesTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - keep_types mode: description: Indicates whether to keep or remove the specified token types. allOf: - $ref: '#/components/schemas/_types.analysis.KeepTypesMode' types: description: List of token types to keep or remove. type: array items: type: string required: - type - types _types.RelationName: type: string _types.query_dsl.GeoPolygonQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: validation_method: default: '''strict''' allOf: - $ref: '#/components/schemas/_types.query_dsl.GeoValidationMethod' ignore_unmapped: type: boolean _types.mapping.TimeSeriesMetricType: type: string enum: - gauge - counter - summary - histogram - position indices._types.FielddataFrequencyFilter: type: object properties: max: type: number min: type: number min_segment_size: type: number required: - max - min - min_segment_size _types.query_dsl.MatchAllQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object _types.analysis.NoriAnalyzer: type: object properties: type: type: string enum: - nori version: deprecated: true allOf: - $ref: '#/components/schemas/_types.VersionString' decompound_mode: allOf: - $ref: '#/components/schemas/_types.analysis.NoriDecompoundMode' stoptags: type: array items: type: string user_dictionary: type: string required: - type _types.KnnRetriever: allOf: - $ref: '#/components/schemas/_types.RetrieverBase' - type: object properties: field: description: The name of the vector field to search against. type: string query_vector: description: Query vector. Must have the same number of dimensions as the vector field you are searching against. You must provide a query_vector_builder or query_vector, but not both. allOf: - $ref: '#/components/schemas/_types.QueryVector' query_vector_builder: description: Defines a model to build a query vector. allOf: - $ref: '#/components/schemas/_types.QueryVectorBuilder' k: description: Number of nearest neighbors to return as top hits. type: number num_candidates: description: Number of nearest neighbor candidates to consider per shard. type: number visit_percentage: description: The percentage of vectors to explore per shard while doing knn search with bbq_disk x-state: Generally available; Added in 9.2.0 type: number similarity: description: The minimum similarity required for a document to be considered a match. type: number rescore_vector: description: Apply oversampling and rescoring to quantized vectors x-state: Generally available; Added in 8.18.0 allOf: - $ref: '#/components/schemas/_types.RescoreVector' required: - field - k _types.analysis.TurkishAnalyzer: type: object properties: type: type: string enum: - turkish stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type _types.mapping.ChunkRescorerChunkingSettings: type: object properties: max_chunk_size: description: 'The maximum size of a chunk in words. This value cannot be lower than `20` (for `sentence` strategy) or `10` (for `word` strategy). This value should not exceed the window size for the associated model.' default: 250.0 type: number overlap: description: 'The number of overlapping words for chunks. It is applicable only to a `word` chunking strategy. This value cannot be higher than half the `max_chunk_size` value.' default: 100.0 type: number sentence_overlap: description: 'The number of overlapping sentences for chunks. It is applicable only for a `sentence` chunking strategy. It can be either `1` or `0`.' default: 1.0 type: number separator_group: description: 'Only applicable to the `recursive` strategy and required when using it. Sets a predefined list of separators in the saved chunking settings based on the selected text type. Values can be `markdown` or `plaintext`. Using this parameter is an alternative to manually specifying a custom `separators` list.' type: string separators: description: 'Only applicable to the `recursive` strategy and required when using it. A list of strings used as possible split points when chunking text. Each string can be a plain string or a regular expression (regex) pattern. The system tries each separator in order to split the text, starting from the first item in the list. After splitting, it attempts to recombine smaller pieces into larger chunks that stay within the `max_chunk_size` limit, to reduce the total number of chunks generated.' type: array items: type: string strategy: externalDocs: url: https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#chunking-strategies description: "The chunking strategy: `sentence`, `word`, `none` or `recursive`.\n\n * If `strategy` is set to `recursive`, you must also specify:\n\n- `max_chunk_size`\n- either `separators` or`separator_group`\n\nLearn more about different chunking strategies in the linked documentation." default: sentence type: string required: - max_chunk_size indices.close.CloseIndexResult: type: object properties: closed: type: boolean shards: type: object additionalProperties: $ref: '#/components/schemas/indices.close.CloseShardResult' required: - closed _types.aggregations.IpPrefixAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: field: description: The IP address field to aggregation on. The field mapping type must be `ip`. allOf: - $ref: '#/components/schemas/_types.Field' prefix_length: description: 'Length of the network prefix. For IPv4 addresses the accepted range is [0, 32]. For IPv6 addresses the accepted range is [0, 128].' type: number is_ipv6: description: Defines whether the prefix applies to IPv6 addresses. default: false type: boolean append_prefix_length: description: Defines whether the prefix length is appended to IP address keys in the response. default: false type: boolean keyed: description: Defines whether buckets are returned as a hash rather than an array in the response. type: boolean min_doc_count: description: Minimum number of documents in a bucket for it to be included in the response. default: 1.0 type: number required: - field - prefix_length _types.analysis.IcuCollationCaseFirst: type: string enum: - lower - upper indices.simulate_template.Overlapping: type: object properties: name: allOf: - $ref: '#/components/schemas/_types.Name' index_patterns: type: array items: type: string required: - name - index_patterns _types.DataStreamName: type: string _types.mapping.IndexField: type: object properties: enabled: type: boolean required: - enabled _types.analysis.SnowballTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - snowball language: description: Controls the language used by the stemmer. allOf: - $ref: '#/components/schemas/_types.analysis.SnowballLanguage' required: - type _types.mapping.TypeMapping: type: object properties: all_field: allOf: - $ref: '#/components/schemas/_types.mapping.AllField' date_detection: type: boolean dynamic: allOf: - $ref: '#/components/schemas/_types.mapping.DynamicMapping' dynamic_date_formats: type: array items: type: string dynamic_templates: type: array items: type: object additionalProperties: $ref: '#/components/schemas/_types.mapping.DynamicTemplate' minProperties: 1 maxProperties: 1 _field_names: allOf: - $ref: '#/components/schemas/_types.mapping.FieldNamesField' index_field: allOf: - $ref: '#/components/schemas/_types.mapping.IndexField' _meta: allOf: - $ref: '#/components/schemas/_types.Metadata' numeric_detection: type: boolean properties: type: object additionalProperties: $ref: '#/components/schemas/_types.mapping.Property' _routing: allOf: - $ref: '#/components/schemas/_types.mapping.RoutingField' _size: allOf: - $ref: '#/components/schemas/_types.mapping.SizeField' _source: allOf: - $ref: '#/components/schemas/_types.mapping.SourceField' runtime: type: object additionalProperties: $ref: '#/components/schemas/_types.mapping.RuntimeField' enabled: type: boolean subobjects: allOf: - $ref: '#/components/schemas/_types.mapping.Subobjects' _data_stream_timestamp: x-state: Generally available; Added in 7.16.0 allOf: - $ref: '#/components/schemas/_types.mapping.DataStreamTimestamp' _types.aggregations.MissingAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: field: description: The name of the field. allOf: - $ref: '#/components/schemas/_types.Field' missing: allOf: - $ref: '#/components/schemas/_types.aggregations.Missing' _types.aggregations.MaxAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase' - type: object _types.analysis.PhoneticRuleType: type: string enum: - approx - exact indices._types.SettingsHighlight: type: object properties: max_analyzed_offset: default: 1000000.0 type: number _types.analysis.UniqueTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - unique only_on_same_position: description: If `true`, only remove duplicate tokens in the same position. Defaults to `false`. type: boolean required: - type _types.aggregations.BucketKsAggregation: description: 'A sibling pipeline aggregation which executes a two sample Kolmogorov–Smirnov test (referred to as a "K-S test" from now on) against a provided distribution, and the distribution implied by the documents counts in the configured sibling aggregation. Specifically, for some metric, assuming that the percentile intervals of the metric are known beforehand or have been computed by an aggregation, then one would use range aggregation for the sibling to compute the p-value of the distribution difference between the metric and the restriction of that metric to a subset of the documents. A natural use case is if the sibling aggregation range aggregation nested in a terms aggregation, in which case one compares the overall distribution of metric to its restriction to each term.' allOf: - $ref: '#/components/schemas/_types.aggregations.BucketPathAggregation' - type: object properties: alternative: description: 'A list of string values indicating which K-S test alternative to calculate. The valid values are: "greater", "less", "two_sided". This parameter is key for determining the K-S statistic used when calculating the K-S test. Default value is all possible alternative hypotheses.' type: array items: type: string fractions: description: 'A list of doubles indicating the distribution of the samples with which to compare to the `buckets_path` results. In typical usage this is the overall proportion of documents in each bucket, which is compared with the actual document proportions in each bucket from the sibling aggregation counts. The default is to assume that overall documents are uniformly distributed on these buckets, which they would be if one used equal percentiles of a metric to define the bucket end points.' type: array items: type: number sampling_method: description: 'Indicates the sampling methodology when calculating the K-S test. Note, this is sampling of the returned values. This determines the cumulative distribution function (CDF) points used comparing the two samples. Default is `upper_tail`, which emphasizes the upper end of the CDF points. Valid options are: `upper_tail`, `uniform`, and `lower_tail`.' type: string _types.KnnEmbeddingInput: description: 'Knn embedding input. Either a string, an object or array of objects' oneOf: - type: string - $ref: '#/components/schemas/_types.InferenceStringGroup' _types.RRFRetriever: allOf: - $ref: '#/components/schemas/_types.RetrieverBase' - type: object properties: retrievers: description: A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them. Each retriever can optionally include a weight parameter. type: array items: $ref: '#/components/schemas/_types.RRFRetrieverEntry' rank_constant: description: This value determines how much influence documents in individual result sets per query have over the final ranked result set. type: number rank_window_size: description: This value determines the size of the individual result sets per query. type: number query: type: string fields: type: array items: type: string required: - retrievers _types.analysis.BengaliAnalyzer: type: object properties: type: type: string enum: - bengali stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type _types.InferenceString: type: object properties: type: description: The type of data that the value represents. allOf: - $ref: '#/components/schemas/inference._types.EmbeddingContentType' format: description: The format of the data. If null, the default data format for the given type is used. oneOf: - $ref: '#/components/schemas/inference._types.EmbeddingContentFormat' - type: - string - 'null' value: description: String which may be raw text, or the string representation of some other data such as an image in base64. type: string required: - type - value _global.search._types.HighlightField: allOf: - $ref: '#/components/schemas/_global.search._types.HighlightBase' - type: object properties: fragment_offset: type: number matched_fields: allOf: - $ref: '#/components/schemas/_types.Fields' _types.aggregations.SumAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase' - type: object _types.aggregations.ExtendedStatsAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase' - type: object properties: sigma: description: The number of standard deviations above/below the mean to display. type: number indices._types.IndexMode: type: string enum: - standard - time_series - logsdb - lookup _types.analysis.SynonymTokenFilterBase: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: expand: description: Expands definitions for equivalent synonym rules. Defaults to `true`. type: boolean format: description: Sets the synonym rules format. allOf: - $ref: '#/components/schemas/_types.analysis.SynonymFormat' lenient: description: If `true` ignores errors while parsing the synonym rules. It is important to note that only those synonym rules which cannot get parsed are ignored. Defaults to the value of the `updateable` setting. type: boolean synonyms: description: Used to define inline synonyms. type: array items: type: string synonyms_path: description: Used to provide a synonym file. This path must be absolute or relative to the `config` location. type: string synonyms_set: description: Provide one or more synonym sets created through the Synonyms Management APIs. Maximum 100 sets per filter. oneOf: - type: string - type: array items: type: string tokenizer: deprecated: true description: Controls the tokenizers that will be used to tokenize the synonym, this parameter is for backwards compatibility for indices that created before 6.0. type: string updateable: description: If `true` allows reloading search analyzers to pick up changes to synonym files. Only to be used for search analyzers. Defaults to `false`. type: boolean _types.analysis.KuromojiStemmerTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - kuromoji_stemmer minimum_length: type: number required: - type - minimum_length _global.search._types.LearningToRank: type: object properties: model_id: description: The unique identifier of the trained model uploaded to Elasticsearch type: string params: description: Named parameters to be passed to the query templates used for feature type: object additionalProperties: type: object required: - model_id indices._types.SourceMode: type: string enum: - disabled - stored - synthetic _types.ScriptSortType: type: string enum: - string - number - version _types.mapping.ChunkingSettings: type: object properties: strategy: externalDocs: url: https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#chunking-strategies description: "The chunking strategy: `sentence`, `word`, `none` or `recursive`.\n\n * If `strategy` is set to `recursive`, you must also specify:\n\n- `max_chunk_size`\n- either `separators` or`separator_group`\n\nLearn more about different chunking strategies in the linked documentation." default: sentence type: string max_chunk_size: description: 'The maximum size of a chunk in words. This value cannot be lower than `20` (for `sentence` strategy) or `10` (for `word` strategy). This value should not exceed the window size for the associated model.' default: 250.0 type: number overlap: description: 'The number of overlapping words for chunks. It is applicable only to a `word` chunking strategy. This value cannot be higher than half the `max_chunk_size` value.' default: 100.0 type: number sentence_overlap: description: 'The number of overlapping sentences for chunks. It is applicable only for a `sentence` chunking strategy. It can be either `1` or `0`.' default: 1.0 type: number separator_group: description: 'Only applicable to the `recursive` strategy and required when using it. Sets a predefined list of separators in the saved chunking settings based on the selected text type. Values can be `markdown` or `plaintext`. Using this parameter is an alternative to manually specifying a custom `separators` list.' type: string separators: description: 'Only applicable to the `recursive` strategy and required when using it. A list of strings used as possible split points when chunking text. Each string can be a plain string or a regular expression (regex) pattern. The system tries each separator in order to split the text, starting from the first item in the list. After splitting, it attempts to recombine smaller pieces into larger chunks that stay within the `max_chunk_size` limit, to reduce the total number of chunks generated.' type: array items: type: string required: - strategy - max_chunk_size _types.mapping.IndexOptions: type: string enum: - docs - freqs - positions - offsets _types.mapping.DenseVectorProperty: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: type: type: string enum: - dense_vector dims: description: 'Number of vector dimensions. Can''t exceed `4096`. If `dims` is not specified, it will be set to the length of the first vector added to the field.' type: number element_type: description: The data type used to encode vectors. The supported data types are `float` (default), `byte`, and `bit`. default: float allOf: - $ref: '#/components/schemas/_types.mapping.DenseVectorElementType' index: description: If `true`, you can search this field using the kNN search API. default: true type: boolean index_options: description: 'An optional section that configures the kNN indexing algorithm. The HNSW algorithm has two internal parameters that influence how the data structure is built. These can be adjusted to improve the accuracy of results, at the expense of slower indexing speed. This parameter can only be specified when `index` is `true`.' allOf: - $ref: '#/components/schemas/_types.mapping.DenseVectorIndexOptions' similarity: description: 'The vector similarity metric to use in kNN search. Documents are ranked by their vector field''s similarity to the query vector. The `_score` of each document will be derived from the similarity, in a way that ensures scores are positive and that a larger score corresponds to a higher ranking. Defaults to `l2_norm` when `element_type` is `bit` otherwise defaults to `cosine`. `bit` vectors only support `l2_norm` as their similarity metric. This parameter can only be specified when `index` is `true`.' allOf: - $ref: '#/components/schemas/_types.mapping.DenseVectorSimilarity' required: - type indices._types.IndexSettingsLifecycle: type: object properties: name: description: The name of the policy to use to manage the index. For information about how Elasticsearch applies policy changes, see Policy updates. allOf: - $ref: '#/components/schemas/_types.Name' indexing_complete: description: 'Indicates whether or not the index has been rolled over. Automatically set to true when ILM completes the rollover action. You can explicitly set it to skip rollover.' default: 'false' allOf: - $ref: '#/components/schemas/_spec_utils.Stringifiedboolean' origination_date: description: 'If specified, this is the timestamp used to calculate the index age for its phase transitions. Use this setting if you create a new index that contains old data and want to use the original creation date to calculate the index age. Specified as a Unix epoch value in milliseconds.' default: 0.0 type: number parse_origination_date: description: 'Set to true to parse the origination date from the index name. This origination date is used to calculate the index age for its phase transitions. The index name must match the pattern ^.*-{date_format}-\\d+, where the date_format is yyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format, for example logs-2016.10.31-000002). If the index name doesn’t match the pattern, index creation fails.' type: boolean step: allOf: - $ref: '#/components/schemas/indices._types.IndexSettingsLifecycleStep' rollover_alias: description: 'The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action. When the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more information about rolling indices, see Rollover.' default: '' type: string prefer_ilm: description: 'Preference for the system that manages a data stream backing index (preferring ILM when both ILM and DLM are applicable for an index).' default: 'true' oneOf: - type: boolean - type: string _types.query_dsl.IntervalsContainer: type: object properties: all_of: description: Returns matches that span a combination of other rules. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsAllOf' any_of: description: Returns intervals produced by any of its sub-rules. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsAnyOf' fuzzy: description: Matches analyzed text. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsFuzzy' match: description: Matches analyzed text. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsMatch' prefix: description: Matches terms that start with a specified set of characters. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsPrefix' range: allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsRange' regexp: allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsRegexp' wildcard: description: Matches terms using a wildcard pattern. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsWildcard' minProperties: 1 maxProperties: 1 indices._types.SegmentSortMissing: type: string enum: - _last - _first ml._types.RegressionInferenceOptions: type: object properties: results_field: description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. allOf: - $ref: '#/components/schemas/_types.Field' num_top_feature_importance_values: description: Specifies the maximum number of feature importance values per document. default: 0.0 type: number _types.mapping.DenseVectorSimilarity: type: string enum: - cosine - dot_product - l2_norm - max_inner_product _types.mapping.RuntimeField: type: object properties: fields: description: For type `composite` type: object additionalProperties: $ref: '#/components/schemas/_types.mapping.CompositeSubField' fetch_fields: description: For type `lookup` type: array items: $ref: '#/components/schemas/_types.mapping.RuntimeFieldFetchFields' format: description: A custom format for `date` type runtime fields. type: string input_field: description: For type `lookup` allOf: - $ref: '#/components/schemas/_types.Field' target_field: description: For type `lookup` allOf: - $ref: '#/components/schemas/_types.Field' target_index: description: For type `lookup` allOf: - $ref: '#/components/schemas/_types.IndexName' script: description: Painless script executed at query time. allOf: - $ref: '#/components/schemas/_types.Script' on_script_error: allOf: - $ref: '#/components/schemas/_types.mapping.OnScriptError' type: description: 'Field type, which can be: `boolean`, `composite`, `date`, `double`, `geo_point`, `ip`,`keyword`, `long`, or `lookup`.' allOf: - $ref: '#/components/schemas/_types.mapping.RuntimeFieldType' required: - type indices._types.SettingsSimilarityIb: type: object properties: type: type: string enum: - IB distribution: allOf: - $ref: '#/components/schemas/_types.IBDistribution' lambda: allOf: - $ref: '#/components/schemas/_types.IBLambda' normalization: allOf: - $ref: '#/components/schemas/_types.Normalization' required: - type - distribution - lambda - normalization _types.DFIIndependenceMeasure: type: string enum: - standardized - saturated - chisquared _types.mapping.DoubleNumberProperty: allOf: - $ref: '#/components/schemas/_types.mapping.NumberPropertyBase' - type: object properties: type: type: string enum: - double null_value: type: number required: - type _types.query_dsl.RandomScoreFunction: type: object properties: field: allOf: - $ref: '#/components/schemas/_types.Field' seed: oneOf: - type: number - type: string _types.aggregations.MedianAbsoluteDeviationAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase' - type: object properties: compression: description: Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. default: 1000.0 type: number execution_hint: description: 'The default implementation of TDigest is optimized for performance, scaling to millions or even billions of sample values while maintaining acceptable accuracy levels (close to 1% relative error for millions of samples in some cases). To use an implementation optimized for accuracy, set this parameter to high_accuracy instead.' default: default allOf: - $ref: '#/components/schemas/_types.aggregations.TDigestExecutionHint' _types.aggregations.RangeAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: field: description: The date field whose values are use to build ranges. allOf: - $ref: '#/components/schemas/_types.Field' missing: description: 'The value to apply to documents that do not have a value. By default, documents without a value are ignored.' type: number ranges: description: An array of ranges used to bucket documents. type: array items: $ref: '#/components/schemas/_types.aggregations.AggregationRange' script: allOf: - $ref: '#/components/schemas/_types.Script' keyed: description: Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array. type: boolean format: type: string _types.query_dsl.LikeDocument: type: object properties: doc: description: A document not present in the index. type: object fields: type: array items: $ref: '#/components/schemas/_types.Field' _id: description: ID of a document. allOf: - $ref: '#/components/schemas/_types.Id' _index: description: Index of a document. allOf: - $ref: '#/components/schemas/_types.IndexName' per_field_analyzer: description: Overrides the default analyzer. type: object additionalProperties: type: string routing: allOf: - $ref: '#/components/schemas/_types.Routing' version: allOf: - $ref: '#/components/schemas/_types.VersionNumber' version_type: default: '''internal''' allOf: - $ref: '#/components/schemas/_types.VersionType' _types.analysis.IcuCollationStrength: type: string enum: - primary - secondary - tertiary - quaternary - identical _types.analysis.GermanStemTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - german_stem required: - type _types.analysis.CharFilter: externalDocs: url: https://www.elastic.co/docs/reference/text-analysis/character-filter-reference oneOf: - type: string - $ref: '#/components/schemas/_types.analysis.CharFilterDefinition' indices.analyze.AnalyzeDetail: type: object properties: analyzer: allOf: - $ref: '#/components/schemas/indices.analyze.AnalyzerDetail' charfilters: type: array items: $ref: '#/components/schemas/indices.analyze.CharFilterDetail' custom_analyzer: type: boolean tokenfilters: type: array items: $ref: '#/components/schemas/indices.analyze.TokenDetail' tokenizer: allOf: - $ref: '#/components/schemas/indices.analyze.TokenDetail' required: - custom_analyzer _types.mapping.DocValues: description: Defines whether doc values are enabled for a field. Can be a simple boolean, or a configuration object for finer-grained control over sub-parameters such as `multi_value`. oneOf: - type: boolean - $ref: '#/components/schemas/_types.mapping.DocValuesConfig' _types.mapping.PercolatorProperty: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: type: type: string enum: - percolator required: - type _types.analysis.TruncateTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - truncate length: description: Character limit for each token. Tokens exceeding this limit are truncated. Defaults to `10`. type: number required: - type indices._types.Alias: type: object properties: filter: description: Query used to limit documents the alias can access. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' index_routing: description: 'Value used to route indexing operations to a specific shard. If specified, this overwrites the `routing` value for indexing operations.' type: string is_hidden: description: 'If `true`, the alias is hidden. All indices for the alias must have the same `is_hidden` value.' default: false type: boolean is_write_index: description: If `true`, the index is the write index for the alias. default: false type: boolean routing: description: Value used to route indexing and search operations to a specific shard. type: string search_routing: description: 'Value used to route search operations to a specific shard. If specified, this overwrites the `routing` value for search operations.' type: string _types.analysis.LimitTokenCountTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - limit consume_all_tokens: description: If `true`, the limit filter exhausts the token stream, even if the `max_token_count` has already been reached. Defaults to `false`. type: boolean max_token_count: description: Maximum number of tokens to keep. Once this limit is reached, any remaining tokens are excluded from the output. Defaults to `1`. allOf: - $ref: '#/components/schemas/_spec_utils.Stringifiedinteger' required: - type indices.remove_block.RemoveIndicesBlockStatus: type: object properties: name: allOf: - $ref: '#/components/schemas/_types.IndexName' unblocked: type: boolean exception: allOf: - $ref: '#/components/schemas/_types.ErrorCause' required: - name indices._types.DataStreamFailureStore: description: Data stream failure store contains the configuration of the failure store for a given data stream. type: object properties: enabled: description: 'If defined, it turns the failure store on/off (`true`/`false`) for this data stream. A data stream failure store that''s disabled (enabled: `false`) will redirect no new failed indices to the failure store; however, it will not remove any existing data from the failure store.' default: true type: boolean lifecycle: description: If defined, it specifies the lifecycle configuration for the failure store of this data stream. allOf: - $ref: '#/components/schemas/indices._types.FailureStoreLifecycle' _types.analysis.GermanAnalyzer: type: object properties: type: type: string enum: - german stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type _types.aggregations.SamplerAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: shard_size: description: Limits how many top-scoring documents are collected in the sample processed on each shard. default: 100.0 type: number _types.query_dsl.PinnedQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-pinned-query allOf: - type: object properties: organic: description: Any choice of query used to rank documents which will be ranked below the "pinned" documents. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' required: - organic - type: object properties: ids: description: 'Document IDs listed in the order they are to appear in results. Required if `docs` is not specified.' type: array items: $ref: '#/components/schemas/_types.Id' docs: description: 'Documents listed in the order they are to appear in results. Required if `ids` is not specified.' type: array items: $ref: '#/components/schemas/_types.query_dsl.PinnedDoc' minProperties: 1 maxProperties: 1 _global.search._types.HighlighterTagsSchema: type: string enum: - styled _types.mapping.DynamicProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: type: type: string enum: - '{dynamic_type}' enabled: type: boolean null_value: allOf: - $ref: '#/components/schemas/_types.FieldValue' boost: type: number coerce: type: boolean script: allOf: - $ref: '#/components/schemas/_types.Script' on_script_error: allOf: - $ref: '#/components/schemas/_types.mapping.OnScriptError' ignore_malformed: type: boolean time_series_metric: allOf: - $ref: '#/components/schemas/_types.mapping.TimeSeriesMetricType' analyzer: type: string eager_global_ordinals: type: boolean index: type: boolean index_options: allOf: - $ref: '#/components/schemas/_types.mapping.IndexOptions' index_phrases: type: boolean index_prefixes: oneOf: - $ref: '#/components/schemas/_types.mapping.TextIndexPrefixes' - type: - string - 'null' norms: type: boolean position_increment_gap: type: number search_analyzer: type: string search_quote_analyzer: type: string term_vector: allOf: - $ref: '#/components/schemas/_types.mapping.TermVectorOption' format: type: string precision_step: type: number locale: type: string required: - type _types.aggregations.IpRangeAggregationRange: type: object properties: from: description: Start of the range. oneOf: - type: string - type: - string - 'null' mask: description: IP range defined as a CIDR mask. type: string to: description: End of the range. oneOf: - type: string - type: - string - 'null' _types.ScriptSort: type: object properties: order: allOf: - $ref: '#/components/schemas/_types.SortOrder' script: allOf: - $ref: '#/components/schemas/_types.Script' type: allOf: - $ref: '#/components/schemas/_types.ScriptSortType' mode: allOf: - $ref: '#/components/schemas/_types.SortMode' nested: allOf: - $ref: '#/components/schemas/_types.NestedSortValue' required: - script _types.query_dsl.FunctionScoreContainer: allOf: - type: object properties: filter: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' weight: type: number _name: description: A name to identify which function matched and influenced the score. x-state: Generally available; Added in 9.4.0 type: string - type: object properties: exp: description: Function that scores a document with a exponential decay, depending on the distance of a numeric field value of the document from an origin. allOf: - $ref: '#/components/schemas/_types.query_dsl.DecayFunction' gauss: description: Function that scores a document with a normal decay, depending on the distance of a numeric field value of the document from an origin. allOf: - $ref: '#/components/schemas/_types.query_dsl.DecayFunction' linear: description: Function that scores a document with a linear decay, depending on the distance of a numeric field value of the document from an origin. allOf: - $ref: '#/components/schemas/_types.query_dsl.DecayFunction' field_value_factor: description: 'Function allows you to use a field from a document to influence the score. It’s similar to using the script_score function, however, it avoids the overhead of scripting.' allOf: - $ref: '#/components/schemas/_types.query_dsl.FieldValueFactorScoreFunction' random_score: description: 'Generates scores that are uniformly distributed from 0 up to but not including 1. In case you want scores to be reproducible, it is possible to provide a `seed` and `field`.' allOf: - $ref: '#/components/schemas/_types.query_dsl.RandomScoreFunction' script_score: description: Enables you to wrap another query and customize the scoring of it optionally with a computation derived from other numeric field values in the doc using a script expression. allOf: - $ref: '#/components/schemas/_types.query_dsl.ScriptScoreFunction' minProperties: 1 maxProperties: 1 _types.analysis.StopAnalyzer: type: object properties: type: type: string enum: - stop version: deprecated: true allOf: - $ref: '#/components/schemas/_types.VersionString' stopwords: description: 'A pre-defined stop words list like `_english_` or an array containing a list of stop words. Defaults to `_none_`.' default: _none_ allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: description: The path to a file containing stop words. type: string required: - type _types.aggregations.HoltWintersType: type: string enum: - add - mult indices.shard_stores.ShardStoreAllocation: type: string enum: - primary - replica - unused _types.analysis.GalicianAnalyzer: type: object properties: type: type: string enum: - galician stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type _types.ShardStatistics: type: object properties: failed: description: The number of shards the operation or search attempted to run on but failed. allOf: - $ref: '#/components/schemas/_types.uint' successful: description: The number of shards the operation or search succeeded on. allOf: - $ref: '#/components/schemas/_types.uint' total: description: The number of shards the operation or search will run on overall. allOf: - $ref: '#/components/schemas/_types.uint' failures: type: array items: $ref: '#/components/schemas/_types.ShardFailure' skipped: allOf: - $ref: '#/components/schemas/_types.uint' required: - failed - successful - total _types.analysis.IcuTokenizer: allOf: - $ref: '#/components/schemas/_types.analysis.TokenizerBase' - type: object properties: type: type: string enum: - icu_tokenizer rule_files: type: string required: - type - rule_files indices.stats.ShardRoutingState: type: string enum: - UNASSIGNED - INITIALIZING - STARTED - RELOCATING inference._types.EmbeddingContentFormat: type: string enum: - text - base64 indices._types.DataStreamOptions: description: 'Data stream options contain the configuration of data stream level features for a given data stream, for example, the failure store configuration.' type: object properties: failure_store: description: If defined, it specifies configuration for the failure store of this data stream. allOf: - $ref: '#/components/schemas/indices._types.DataStreamFailureStore' indices.shard_stores.IndicesShardStores: type: object properties: shards: type: object additionalProperties: $ref: '#/components/schemas/indices.shard_stores.ShardStoreWrapper' required: - shards _types.analysis.WordDelimiterGraphTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.WordDelimiterTokenFilterBase' - type: object properties: type: type: string enum: - word_delimiter_graph adjust_offsets: description: If `true`, the filter adjusts the offsets of split or catenated tokens to better reflect their actual position in the token stream. Defaults to `true`. type: boolean ignore_keywords: description: If `true`, the filter skips tokens with a keyword attribute of true. Defaults to `false`. type: boolean required: - type _types.aggregations.RandomSamplerAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: probability: description: 'The probability that a document will be included in the aggregated data. Must be greater than 0, less than 0.5, or exactly 1. The lower the probability, the fewer documents are matched.' type: number seed: description: 'The seed to generate the random sampling of documents. When a seed is provided, the random subset of documents is the same between calls.' type: number shard_seed: description: When combined with seed, setting shard_seed ensures 100% consistent sampling over shards where data is exactly the same. x-state: Generally available; Added in 8.14.0 type: number required: - probability _types.query_dsl.IntervalsAllOf: type: object properties: intervals: description: An array of rules to combine. All rules must produce a match in a document for the overall source to match. type: array items: $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer' max_gaps: description: 'Maximum number of positions between the matching terms. Intervals produced by the rules further apart than this are not considered matches.' default: -1.0 type: number ordered: description: If `true`, intervals produced by the rules should appear in the order in which they are specified. default: false type: boolean filter: description: Rule used to filter returned intervals. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsFilter' required: - intervals _types.query_dsl.ShapeQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: ignore_unmapped: description: When set to `true` the query ignores an unmapped field and will not match any documents. type: boolean _types.analysis.CatalanAnalyzer: type: object properties: type: type: string enum: - catalan stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type indices._types.Translog: type: object properties: sync_interval: description: 'How often the translog is fsynced to disk and committed, regardless of write operations. Values less than 100ms are not allowed.' default: 5s allOf: - $ref: '#/components/schemas/_types.Duration' durability: description: Whether or not to `fsync` and commit the translog after every index, delete, update, or bulk request. default: string allOf: - $ref: '#/components/schemas/indices._types.TranslogDurability' flush_threshold_size: description: 'The translog stores all operations that are not yet safely persisted in Lucene (i.e., are not part of a Lucene commit point). Although these operations are available for reads, they will need to be replayed if the shard was stopped and had to be recovered. This setting controls the maximum total size of these operations, to prevent recoveries from taking too long. Once the maximum size has been reached a flush will happen, generating a new Lucene commit point.' default: 512mb allOf: - $ref: '#/components/schemas/_types.ByteSize' retention: allOf: - $ref: '#/components/schemas/indices._types.TranslogRetention' _types.analysis.PersianAnalyzer: type: object properties: type: type: string enum: - persian stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string required: - type _types.aggregations.NormalizeAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object properties: method: description: The specific method to apply. allOf: - $ref: '#/components/schemas/_types.aggregations.NormalizeMethod' _types.analysis.CjkBigramTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - cjk_bigram ignored_scripts: description: Array of character scripts for which to disable bigrams. type: array items: $ref: '#/components/schemas/_types.analysis.CjkBigramIgnoredScript' output_unigrams: description: If `true`, emit tokens in both bigram and unigram form. If `false`, a CJK character is output in unigram form when it has no adjacent characters. Defaults to `false`. type: boolean required: - type _types.analysis.CharFilterDefinition: discriminator: propertyName: type mapping: html_strip: '#/components/schemas/_types.analysis.HtmlStripCharFilter' icu_normalizer: '#/components/schemas/_types.analysis.IcuNormalizationCharFilter' kuromoji_iteration_mark: '#/components/schemas/_types.analysis.KuromojiIterationMarkCharFilter' mapping: '#/components/schemas/_types.analysis.MappingCharFilter' pattern_replace: '#/components/schemas/_types.analysis.PatternReplaceCharFilter' oneOf: - $ref: '#/components/schemas/_types.analysis.HtmlStripCharFilter' - $ref: '#/components/schemas/_types.analysis.MappingCharFilter' - $ref: '#/components/schemas/_types.analysis.PatternReplaceCharFilter' - $ref: '#/components/schemas/_types.analysis.IcuNormalizationCharFilter' - $ref: '#/components/schemas/_types.analysis.KuromojiIterationMarkCharFilter' _types.aggregations.MovingAverageAggregation: discriminator: propertyName: model mapping: ewma: '#/components/schemas/_types.aggregations.EwmaMovingAverageAggregation' holt: '#/components/schemas/_types.aggregations.HoltMovingAverageAggregation' holt_winters: '#/components/schemas/_types.aggregations.HoltWintersMovingAverageAggregation' linear: '#/components/schemas/_types.aggregations.LinearMovingAverageAggregation' simple: '#/components/schemas/_types.aggregations.SimpleMovingAverageAggregation' oneOf: - $ref: '#/components/schemas/_types.aggregations.LinearMovingAverageAggregation' - $ref: '#/components/schemas/_types.aggregations.SimpleMovingAverageAggregation' - $ref: '#/components/schemas/_types.aggregations.EwmaMovingAverageAggregation' - $ref: '#/components/schemas/_types.aggregations.HoltMovingAverageAggregation' - $ref: '#/components/schemas/_types.aggregations.HoltWintersMovingAverageAggregation' indices.shard_stores.ShardStoreStatus: type: string enum: - green - yellow - red - all _types.query_dsl.SimpleQueryStringFlags: description: Query flags can be either a single flag or a combination of flags, e.g. `OR|AND|PREFIX` allOf: - $ref: '#/components/schemas/_spec_utils.PipeSeparatedFlagsSimpleQueryStringFlag' _types.mapping.PreserveLeafArrays: type: string enum: - lossy - exact _types.aggregations.CompositeDateHistogramAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.CompositeAggregationBase' - type: object properties: format: type: string calendar_interval: description: Either `calendar_interval` or `fixed_interval` must be present allOf: - $ref: '#/components/schemas/_types.DurationLarge' fixed_interval: description: Either `calendar_interval` or `fixed_interval` must be present allOf: - $ref: '#/components/schemas/_types.DurationLarge' offset: allOf: - $ref: '#/components/schemas/_types.Duration' time_zone: allOf: - $ref: '#/components/schemas/_types.TimeZone' _types.Names: oneOf: - $ref: '#/components/schemas/_types.Name' - type: array items: $ref: '#/components/schemas/_types.Name' _types.analysis.CharGroupTokenizer: allOf: - $ref: '#/components/schemas/_types.analysis.TokenizerBase' - type: object properties: type: type: string enum: - char_group tokenize_on_chars: type: array items: type: string max_token_length: type: number required: - type - tokenize_on_chars _types.aggregations.CardinalityAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase' - type: object properties: precision_threshold: description: 'A unique count below which counts are expected to be close to accurate. This allows to trade memory for accuracy.' default: 3000.0 type: number rehash: type: boolean execution_hint: description: Mechanism by which cardinality aggregations is run. allOf: - $ref: '#/components/schemas/_types.aggregations.CardinalityExecutionMode' _types.query_dsl.RangeRelation: type: string enum: - within - contains - intersects _types.mapping.Property: discriminator: propertyName: type mapping: aggregate_metric_double: '#/components/schemas/_types.mapping.AggregateMetricDoubleProperty' alias: '#/components/schemas/_types.mapping.FieldAliasProperty' binary: '#/components/schemas/_types.mapping.BinaryProperty' boolean: '#/components/schemas/_types.mapping.BooleanProperty' byte: '#/components/schemas/_types.mapping.ByteNumberProperty' completion: '#/components/schemas/_types.mapping.CompletionProperty' constant_keyword: '#/components/schemas/_types.mapping.ConstantKeywordProperty' counted_keyword: '#/components/schemas/_types.mapping.CountedKeywordProperty' date: '#/components/schemas/_types.mapping.DateProperty' date_nanos: '#/components/schemas/_types.mapping.DateNanosProperty' date_range: '#/components/schemas/_types.mapping.DateRangeProperty' dense_vector: '#/components/schemas/_types.mapping.DenseVectorProperty' double: '#/components/schemas/_types.mapping.DoubleNumberProperty' double_range: '#/components/schemas/_types.mapping.DoubleRangeProperty' exponential_histogram: '#/components/schemas/_types.mapping.ExponentialHistogramProperty' flattened: '#/components/schemas/_types.mapping.FlattenedProperty' float: '#/components/schemas/_types.mapping.FloatNumberProperty' float_range: '#/components/schemas/_types.mapping.FloatRangeProperty' geo_point: '#/components/schemas/_types.mapping.GeoPointProperty' geo_shape: '#/components/schemas/_types.mapping.GeoShapeProperty' half_float: '#/components/schemas/_types.mapping.HalfFloatNumberProperty' histogram: '#/components/schemas/_types.mapping.HistogramProperty' icu_collation_keyword: '#/components/schemas/_types.mapping.IcuCollationProperty' integer: '#/components/schemas/_types.mapping.IntegerNumberProperty' integer_range: '#/components/schemas/_types.mapping.IntegerRangeProperty' ip: '#/components/schemas/_types.mapping.IpProperty' ip_range: '#/components/schemas/_types.mapping.IpRangeProperty' join: '#/components/schemas/_types.mapping.JoinProperty' keyword: '#/components/schemas/_types.mapping.KeywordProperty' long: '#/components/schemas/_types.mapping.LongNumberProperty' long_range: '#/components/schemas/_types.mapping.LongRangeProperty' match_only_text: '#/components/schemas/_types.mapping.MatchOnlyTextProperty' murmur3: '#/components/schemas/_types.mapping.Murmur3HashProperty' nested: '#/components/schemas/_types.mapping.NestedProperty' object: '#/components/schemas/_types.mapping.ObjectProperty' passthrough: '#/components/schemas/_types.mapping.PassthroughObjectProperty' percolator: '#/components/schemas/_types.mapping.PercolatorProperty' point: '#/components/schemas/_types.mapping.PointProperty' rank_feature: '#/components/schemas/_types.mapping.RankFeatureProperty' rank_features: '#/components/schemas/_types.mapping.RankFeaturesProperty' rank_vectors: '#/components/schemas/_types.mapping.RankVectorProperty' scaled_float: '#/components/schemas/_types.mapping.ScaledFloatNumberProperty' search_as_you_type: '#/components/schemas/_types.mapping.SearchAsYouTypeProperty' semantic_text: '#/components/schemas/_types.mapping.SemanticTextProperty' shape: '#/components/schemas/_types.mapping.ShapeProperty' short: '#/components/schemas/_types.mapping.ShortNumberProperty' sparse_vector: '#/components/schemas/_types.mapping.SparseVectorProperty' text: '#/components/schemas/_types.mapping.TextProperty' token_count: '#/components/schemas/_types.mapping.TokenCountProperty' unsigned_long: '#/components/schemas/_types.mapping.UnsignedLongNumberProperty' version: '#/components/schemas/_types.mapping.VersionProperty' wildcard: '#/components/schemas/_types.mapping.WildcardProperty' '{dynamic_type}': '#/components/schemas/_types.mapping.DynamicProperty' oneOf: - $ref: '#/components/schemas/_types.mapping.BinaryProperty' - $ref: '#/components/schemas/_types.mapping.BooleanProperty' - $ref: '#/components/schemas/_types.mapping.DynamicProperty' - $ref: '#/components/schemas/_types.mapping.JoinProperty' - $ref: '#/components/schemas/_types.mapping.KeywordProperty' - $ref: '#/components/schemas/_types.mapping.MatchOnlyTextProperty' - $ref: '#/components/schemas/_types.mapping.PercolatorProperty' - $ref: '#/components/schemas/_types.mapping.RankFeatureProperty' - $ref: '#/components/schemas/_types.mapping.RankFeaturesProperty' - $ref: '#/components/schemas/_types.mapping.SearchAsYouTypeProperty' - $ref: '#/components/schemas/_types.mapping.TextProperty' - $ref: '#/components/schemas/_types.mapping.VersionProperty' - $ref: '#/components/schemas/_types.mapping.WildcardProperty' - $ref: '#/components/schemas/_types.mapping.DateNanosProperty' - $ref: '#/components/schemas/_types.mapping.DateProperty' - $ref: '#/components/schemas/_types.mapping.AggregateMetricDoubleProperty' - $ref: '#/components/schemas/_types.mapping.DenseVectorProperty' - $ref: '#/components/schemas/_types.mapping.FlattenedProperty' - $ref: '#/components/schemas/_types.mapping.NestedProperty' - $ref: '#/components/schemas/_types.mapping.ObjectProperty' - $ref: '#/components/schemas/_types.mapping.PassthroughObjectProperty' - $ref: '#/components/schemas/_types.mapping.RankVectorProperty' - $ref: '#/components/schemas/_types.mapping.SemanticTextProperty' - $ref: '#/components/schemas/_types.mapping.SparseVectorProperty' - $ref: '#/components/schemas/_types.mapping.CompletionProperty' - $ref: '#/components/schemas/_types.mapping.ConstantKeywordProperty' - $ref: '#/components/schemas/_types.mapping.CountedKeywordProperty' - $ref: '#/components/schemas/_types.mapping.FieldAliasProperty' - $ref: '#/components/schemas/_types.mapping.HistogramProperty' - $ref: '#/components/schemas/_types.mapping.ExponentialHistogramProperty' - $ref: '#/components/schemas/_types.mapping.IpProperty' - $ref: '#/components/schemas/_types.mapping.Murmur3HashProperty' - $ref: '#/components/schemas/_types.mapping.TokenCountProperty' - $ref: '#/components/schemas/_types.mapping.GeoPointProperty' - $ref: '#/components/schemas/_types.mapping.GeoShapeProperty' - $ref: '#/components/schemas/_types.mapping.PointProperty' - $ref: '#/components/schemas/_types.mapping.ShapeProperty' - $ref: '#/components/schemas/_types.mapping.ByteNumberProperty' - $ref: '#/components/schemas/_types.mapping.DoubleNumberProperty' - $ref: '#/components/schemas/_types.mapping.FloatNumberProperty' - $ref: '#/components/schemas/_types.mapping.HalfFloatNumberProperty' - $ref: '#/components/schemas/_types.mapping.IntegerNumberProperty' - $ref: '#/components/schemas/_types.mapping.LongNumberProperty' - $ref: '#/components/schemas/_types.mapping.ScaledFloatNumberProperty' - $ref: '#/components/schemas/_types.mapping.ShortNumberProperty' - $ref: '#/components/schemas/_types.mapping.UnsignedLongNumberProperty' - $ref: '#/components/schemas/_types.mapping.DateRangeProperty' - $ref: '#/components/schemas/_types.mapping.DoubleRangeProperty' - $ref: '#/components/schemas/_types.mapping.FloatRangeProperty' - $ref: '#/components/schemas/_types.mapping.IntegerRangeProperty' - $ref: '#/components/schemas/_types.mapping.IpRangeProperty' - $ref: '#/components/schemas/_types.mapping.LongRangeProperty' - $ref: '#/components/schemas/_types.mapping.IcuCollationProperty' _types.analysis.KuromojiTokenizationMode: type: string enum: - normal - search - extended _types.analysis.NGramTokenizer: allOf: - $ref: '#/components/schemas/_types.analysis.TokenizerBase' - type: object properties: type: type: string enum: - ngram custom_token_chars: type: string max_gram: type: number min_gram: type: number token_chars: default: [] type: array items: $ref: '#/components/schemas/_types.analysis.TokenChar' required: - type _types.analysis.KuromojiTokenizer: allOf: - $ref: '#/components/schemas/_types.analysis.TokenizerBase' - type: object properties: type: type: string enum: - kuromoji_tokenizer discard_punctuation: type: boolean mode: allOf: - $ref: '#/components/schemas/_types.analysis.KuromojiTokenizationMode' nbest_cost: type: number nbest_examples: type: string user_dictionary: type: string user_dictionary_rules: type: array items: type: string discard_compound_token: type: boolean required: - type - mode _types.analysis.StemmerTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - stemmer language: type: string required: - type _types.SegmentsStats: type: object properties: count: description: Total number of segments across all shards assigned to selected nodes. type: number doc_values_memory: description: Total amount of memory used for doc values across all shards assigned to selected nodes. allOf: - $ref: '#/components/schemas/_types.ByteSize' doc_values_memory_in_bytes: description: Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes. type: number file_sizes: description: 'This object is not populated by the cluster stats API. To get information on segment files, use the node stats API.' type: object additionalProperties: $ref: '#/components/schemas/indices.stats.ShardFileSizeInfo' fixed_bit_set: description: 'Total amount of memory used by fixed bit sets across all shards assigned to selected nodes. Fixed bit sets are used for nested object field types and type filters for join fields.' allOf: - $ref: '#/components/schemas/_types.ByteSize' fixed_bit_set_memory_in_bytes: description: Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes. type: number index_writer_memory: description: Total amount of memory used by all index writers across all shards assigned to selected nodes. allOf: - $ref: '#/components/schemas/_types.ByteSize' index_writer_memory_in_bytes: description: Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes. type: number max_unsafe_auto_id_timestamp: description: Unix timestamp, in milliseconds, of the most recently retried indexing request. type: number memory: description: Total amount of memory used for segments across all shards assigned to selected nodes. allOf: - $ref: '#/components/schemas/_types.ByteSize' memory_in_bytes: description: Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes. type: number norms_memory: description: Total amount of memory used for normalization factors across all shards assigned to selected nodes. allOf: - $ref: '#/components/schemas/_types.ByteSize' norms_memory_in_bytes: description: Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes. type: number points_memory: description: Total amount of memory used for points across all shards assigned to selected nodes. allOf: - $ref: '#/components/schemas/_types.ByteSize' points_memory_in_bytes: description: Total amount, in bytes, of memory used for points across all shards assigned to selected nodes. type: number stored_fields_memory_in_bytes: description: Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes. type: number stored_fields_memory: description: Total amount of memory used for stored fields across all shards assigned to selected nodes. allOf: - $ref: '#/components/schemas/_types.ByteSize' terms_memory_in_bytes: description: Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes. type: number terms_memory: description: Total amount of memory used for terms across all shards assigned to selected nodes. allOf: - $ref: '#/components/schemas/_types.ByteSize' term_vectors_memory: description: Total amount of memory used for term vectors across all shards assigned to selected nodes. allOf: - $ref: '#/components/schemas/_types.ByteSize' term_vectors_memory_in_bytes: description: Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes. type: number version_map_memory: description: Total amount of memory used by all version maps across all shards assigned to selected nodes. allOf: - $ref: '#/components/schemas/_types.ByteSize' version_map_memory_in_bytes: description: Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes. type: number required: - count - doc_values_memory_in_bytes - file_sizes - fixed_bit_set_memory_in_bytes - index_writer_memory_in_bytes - max_unsafe_auto_id_timestamp - memory_in_bytes - norms_memory_in_bytes - points_memory_in_bytes - stored_fields_memory_in_bytes - terms_memory_in_bytes - term_vectors_memory_in_bytes - version_map_memory_in_bytes _types.analysis.CommonGramsTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - common_grams common_words: description: 'A list of tokens. The filter generates bigrams for these tokens. Either this or the `common_words_path` parameter is required.' type: array items: type: string common_words_path: description: 'Path to a file containing a list of tokens. The filter generates bigrams for these tokens. This path must be absolute or relative to the `config` location. The file must be UTF-8 encoded. Each token in the file must be separated by a line break. Either this or the `common_words` parameter is required.' type: string ignore_case: description: If `true`, matches for common words matching are case-insensitive. Defaults to `false`. type: boolean query_mode: description: 'If `true`, the filter excludes the following tokens from the output: - Unigrams for common words - Unigrams for terms followed by common words Defaults to `false`. We recommend enabling this parameter for search analyzers.' type: boolean required: - type _types.query_dsl.DecayFunction: oneOf: - $ref: '#/components/schemas/_types.query_dsl.UntypedDecayFunction' - $ref: '#/components/schemas/_types.query_dsl.DateDecayFunction' - $ref: '#/components/schemas/_types.query_dsl.NumericDecayFunction' - $ref: '#/components/schemas/_types.query_dsl.GeoDecayFunction' _types.query_dsl.PrefixQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: rewrite: description: Method used to rewrite the query. allOf: - $ref: '#/components/schemas/_types.MultiTermQueryRewrite' value: description: Beginning characters of terms you wish to find in the provided field. type: string case_insensitive: description: 'Allows case insensitive matching of the value with the indexed field values when set to `true`. Default is `false` which means the case sensitivity of matching depends on the underlying field’s mapping.' default: false x-state: Generally available; Added in 7.10.0 type: boolean required: - value _types.analysis.IcuCollationDecomposition: type: string enum: - 'no' - identical _types.BulkStats: type: object properties: total_operations: type: number total_time: allOf: - $ref: '#/components/schemas/_types.Duration' total_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' total_size: allOf: - $ref: '#/components/schemas/_types.ByteSize' total_size_in_bytes: type: number avg_time: allOf: - $ref: '#/components/schemas/_types.Duration' avg_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' avg_size: allOf: - $ref: '#/components/schemas/_types.ByteSize' avg_size_in_bytes: type: number required: - total_operations - total_time_in_millis - total_size_in_bytes - avg_time_in_millis - avg_size_in_bytes _global.search._types.SourceConfig: description: Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered. oneOf: - type: boolean - $ref: '#/components/schemas/_global.search._types.SourceFilter' _types.FlushStats: type: object properties: periodic: type: number total: type: number total_time: allOf: - $ref: '#/components/schemas/_types.Duration' total_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' total_time_excluding_waiting: allOf: - $ref: '#/components/schemas/_types.Duration' total_time_excluding_waiting_on_lock_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' required: - periodic - total - total_time_in_millis - total_time_excluding_waiting_on_lock_in_millis _types.DurationLarge: description: 'A date histogram interval. Similar to `Duration` with additional units: `w` (week), `M` (month), `q` (quarter) and `y` (year)' type: string _global.search._types.HighlightBase: type: object properties: type: allOf: - $ref: '#/components/schemas/_global.search._types.HighlighterType' boundary_chars: description: A string that contains each boundary character. default: .,!? \t\n type: string boundary_max_scan: description: How far to scan for boundary characters. default: 20.0 type: number boundary_scanner: description: 'Specifies how to break the highlighted fragments: chars, sentence, or word. Only valid for the unified and fvh highlighters. Defaults to `sentence` for the `unified` highlighter. Defaults to `chars` for the `fvh` highlighter.' allOf: - $ref: '#/components/schemas/_global.search._types.BoundaryScanner' boundary_scanner_locale: description: 'Controls which locale is used to search for sentence and word boundaries. This parameter takes a form of a language tag, for example: `"en-US"`, `"fr-FR"`, `"ja-JP"`.' default: Locale.ROOT type: string force_source: deprecated: true type: boolean fragmenter: description: 'Specifies how text should be broken up in highlight snippets: `simple` or `span`. Only valid for the `plain` highlighter.' default: span allOf: - $ref: '#/components/schemas/_global.search._types.HighlighterFragmenter' fragment_size: description: The size of the highlighted fragment in characters. default: 100.0 type: number highlight_filter: type: boolean highlight_query: description: 'Highlight matches for a query other than the search query. This is especially useful if you use a rescore query because those are not taken into account by highlighting by default.' allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' max_fragment_length: type: number max_analyzed_offset: description: 'If set to a non-negative value, highlighting stops at this defined maximum limit. The rest of the text is not processed, thus not highlighted and no error is returned The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it’s set to lower value than the query setting.' type: number no_match_size: description: The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. default: 0.0 type: number number_of_fragments: description: 'The maximum number of fragments to return. If the number of fragments is set to `0`, no fragments are returned. Instead, the entire field contents are highlighted and returned. This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. If `number_of_fragments` is `0`, `fragment_size` is ignored.' default: 5.0 type: number options: type: object additionalProperties: type: object order: description: 'Sorts highlighted fragments by score when set to `score`. By default, fragments will be output in the order they appear in the field (order: `none`). Setting this option to `score` will output the most relevant fragments first. Each highlighter applies its own logic to compute relevancy scores.' default: none allOf: - $ref: '#/components/schemas/_global.search._types.HighlighterOrder' phrase_limit: description: 'Controls the number of matching phrases in a document that are considered. Prevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory. When using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory. Only supported by the `fvh` highlighter.' default: 256.0 type: number post_tags: description: 'Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in `` and `` tags.' type: array items: type: string pre_tags: description: 'Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in `` and `` tags.' type: array items: type: string require_field_match: description: 'By default, only fields that contains a query match are highlighted. Set to `false` to highlight all fields.' default: true type: boolean tags_schema: description: Set to `styled` to use the built-in tag schema. allOf: - $ref: '#/components/schemas/_global.search._types.HighlighterTagsSchema' _spec_utils.StringifiedEpochTimeUnitMillis: description: 'Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.' oneOf: - $ref: '#/components/schemas/_types.EpochTimeUnitMillis' - type: string _types.LatLonGeoLocation: type: object properties: lat: description: Latitude type: number lon: description: Longitude type: number required: - lat - lon _types.analysis.UaxEmailUrlTokenizer: allOf: - $ref: '#/components/schemas/_types.analysis.TokenizerBase' - type: object properties: type: type: string enum: - uax_url_email max_token_length: type: number required: - type _types.aggregations.PercentilesAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase' - type: object properties: keyed: description: 'By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array. Set to `false` to disable this behavior.' default: true type: boolean percents: description: The percentiles to calculate. oneOf: - type: number - type: array items: type: number hdr: description: Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles. allOf: - $ref: '#/components/schemas/_types.aggregations.HdrMethod' tdigest: description: Sets parameters for the default TDigest algorithm used to calculate percentiles. allOf: - $ref: '#/components/schemas/_types.aggregations.TDigest' _types.aggregations.NormalizeMethod: type: string enum: - rescale_0_1 - rescale_0_100 - percent_of_sum - mean - z-score - softmax _types.analysis.IcuNormalizationTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - icu_normalizer name: allOf: - $ref: '#/components/schemas/_types.analysis.IcuNormalizationType' required: - type - name indices._types.DataStreamFailureStoreTemplate: description: Template equivalent of DataStreamFailureStore that allows nullable values. type: object properties: enabled: description: 'If defined, it turns the failure store on/off (`true`/`false`) for this data stream. A data stream failure store that''s disabled (enabled: `false`) will redirect no new failed indices to the failure store; however, it will not remove any existing data from the failure store.' default: 'true' oneOf: - type: boolean - type: - string - 'null' lifecycle: description: If defined, it specifies the lifecycle configuration for the failure store of this data stream. oneOf: - $ref: '#/components/schemas/indices._types.FailureStoreLifecycleTemplate' - type: - string - 'null' _types.aggregations.VariableWidthHistogramAggregation: type: object properties: field: description: The name of the field. allOf: - $ref: '#/components/schemas/_types.Field' buckets: description: The target number of buckets. default: 10.0 type: number shard_size: description: 'The number of buckets that the coordinating node will request from each shard. Defaults to `buckets * 50`.' type: number initial_buffer: description: 'Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run. Defaults to `min(10 * shard_size, 50000)`.' type: number script: allOf: - $ref: '#/components/schemas/_types.Script' _types.aggregations.RateAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase' - type: object properties: unit: description: 'The interval used to calculate the rate. By default, the interval of the `date_histogram` is used.' allOf: - $ref: '#/components/schemas/_types.aggregations.CalendarInterval' mode: description: How the rate is calculated. default: sum allOf: - $ref: '#/components/schemas/_types.aggregations.RateMode' _types.GetStats: type: object properties: current: type: number exists_time: allOf: - $ref: '#/components/schemas/_types.Duration' exists_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' exists_total: type: number missing_time: allOf: - $ref: '#/components/schemas/_types.Duration' missing_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' missing_total: type: number getTime: allOf: - $ref: '#/components/schemas/_types.Duration' time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' total: type: number required: - current - exists_time_in_millis - exists_total - missing_time_in_millis - missing_total - time_in_millis - total _types.aggregations.CategorizeTextAggregation: description: 'A multi-bucket aggregation that groups semi-structured text into buckets. Each text field is re-analyzed using a custom analyzer. The resulting tokens are then categorized creating buckets of similarly formatted text values. This aggregation works best with machine generated text like system logs. Only the first 100 analyzed tokens are used to categorize the text.' allOf: - $ref: '#/components/schemas/_types.aggregations.Aggregation' - type: object properties: field: description: The semi-structured text field to categorize. allOf: - $ref: '#/components/schemas/_types.Field' max_unique_tokens: description: 'The maximum number of unique tokens at any position up to max_matched_tokens. Must be larger than 1. Smaller values use less memory and create fewer categories. Larger values will use more memory and create narrower categories. Max allowed value is 100.' default: 50.0 type: number max_matched_tokens: description: 'The maximum number of token positions to match on before attempting to merge categories. Larger values will use more memory and create narrower categories. Max allowed value is 100.' default: 5.0 type: number similarity_threshold: description: 'The minimum percentage of tokens that must match for text to be added to the category bucket. Must be between 1 and 100. The larger the value the narrower the categories. Larger values will increase memory usage and create narrower categories.' default: 50.0 type: number categorization_filters: description: 'This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as categorization_analyzer. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the categorization_analyzer property instead and include the filters as pattern_replace character filters.' type: array items: type: string categorization_analyzer: externalDocs: url: https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-analyze description: 'The categorization analyzer specifies how the text is analyzed and tokenized before being categorized. The syntax is very similar to that used to define the analyzer in the analyze API. This property cannot be used at the same time as `categorization_filters`.' allOf: - $ref: '#/components/schemas/_types.aggregations.CategorizeTextAnalyzer' shard_size: description: The number of categorization buckets to return from each shard before merging all the results. type: number size: description: The number of buckets to return. default: 10.0 type: number min_doc_count: description: The minimum number of documents in a bucket to be returned to the results. type: number shard_min_doc_count: description: The minimum number of documents in a bucket to be returned from the shard before merging. type: number required: - field _types.query_dsl.IntervalsFilter: type: object properties: after: description: Query used to return intervals that follow an interval from the `filter` rule. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer' before: description: Query used to return intervals that occur before an interval from the `filter` rule. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer' contained_by: description: Query used to return intervals contained by an interval from the `filter` rule. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer' containing: description: Query used to return intervals that contain an interval from the `filter` rule. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer' not_contained_by: description: Query used to return intervals that are **not** contained by an interval from the `filter` rule. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer' not_containing: description: Query used to return intervals that do **not** contain an interval from the `filter` rule. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer' not_overlapping: description: Query used to return intervals that do **not** overlap with an interval from the `filter` rule. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer' overlapping: description: Query used to return intervals that overlap with an interval from the `filter` rule. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer' script: description: 'Script used to return matching documents. This script must return a boolean value: `true` or `false`.' allOf: - $ref: '#/components/schemas/_types.Script' minProperties: 1 maxProperties: 1 _types.aggregations.TestPopulation: type: object properties: field: description: The field to aggregate. allOf: - $ref: '#/components/schemas/_types.Field' script: allOf: - $ref: '#/components/schemas/_types.Script' filter: description: A filter used to define a set of records to run unpaired t-test on. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' required: - field _types.aggregations.CustomCategorizeTextAnalyzer: type: object properties: char_filter: type: array items: type: string tokenizer: type: string filter: type: array items: type: string _types.mapping.GeoStrategy: type: string enum: - recursive - term _types.GlobalOrdinalsStats: type: object properties: build_time_in_millis: allOf: - $ref: '#/components/schemas/_types.UnitMillis' build_time: type: string fields: type: object additionalProperties: $ref: '#/components/schemas/_types.GlobalOrdinalFieldStats' required: - build_time_in_millis _types.short: type: number _types.aggregations.MultiTermsAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: collect_mode: description: Specifies the strategy for data collection. default: breadth_first allOf: - $ref: '#/components/schemas/_types.aggregations.TermsAggregationCollectMode' order: description: 'Specifies the sort order of the buckets. Defaults to sorting by descending document count.' allOf: - $ref: '#/components/schemas/_types.aggregations.AggregateOrder' min_doc_count: description: The minimum number of documents in a bucket for it to be returned. default: 1.0 type: number shard_min_doc_count: description: The minimum number of documents in a bucket on each shard for it to be returned. default: 1.0 type: number shard_size: description: 'The number of candidate terms produced by each shard. By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter.' type: number show_term_doc_count_error: description: Calculates the doc count error on per term basis. default: false type: boolean size: description: The number of term buckets should be returned out of the overall terms list. default: 10.0 type: number terms: description: The field from which to generate sets of terms. type: array items: $ref: '#/components/schemas/_types.aggregations.MultiTermLookup' required: - terms _global.search._types.Highlight: allOf: - $ref: '#/components/schemas/_global.search._types.HighlightBase' - type: object properties: encoder: allOf: - $ref: '#/components/schemas/_global.search._types.HighlighterEncoder' fields: oneOf: - type: object additionalProperties: $ref: '#/components/schemas/_global.search._types.HighlightField' minProperties: 1 maxProperties: 1 - type: array items: type: object additionalProperties: $ref: '#/components/schemas/_global.search._types.HighlightField' minProperties: 1 maxProperties: 1 required: - fields indices.delete_alias.IndicesAliasesResponseBody: allOf: - $ref: '#/components/schemas/_types.AcknowledgedResponseBase' - type: object properties: errors: type: boolean _types.query_dsl.SpanFieldMaskingQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: field: allOf: - $ref: '#/components/schemas/_types.Field' query: allOf: - $ref: '#/components/schemas/_types.query_dsl.SpanQuery' required: - field - query indices.get.Feature: type: string enum: - aliases - mappings - settings _types.analysis.ShingleTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - shingle filler_token: description: String used in shingles as a replacement for empty positions that do not contain a token. This filler token is only used in shingles, not original unigrams. Defaults to an underscore (`_`). type: string max_shingle_size: description: Maximum number of tokens to concatenate when creating shingles. Defaults to `2`. allOf: - $ref: '#/components/schemas/_spec_utils.Stringifiedinteger' min_shingle_size: description: Minimum number of tokens to concatenate when creating shingles. Defaults to `2`. allOf: - $ref: '#/components/schemas/_spec_utils.Stringifiedinteger' output_unigrams: description: If `true`, the output includes the original input tokens. If `false`, the output only includes shingles; the original input tokens are removed. Defaults to `true`. type: boolean output_unigrams_if_no_shingles: description: If `true`, the output includes the original input tokens only if no shingles are produced; if shingles are produced, the output only includes shingles. Defaults to `false`. type: boolean token_separator: description: Separator used to concatenate adjacent tokens to form a shingle. Defaults to a space (`" "`). type: string required: - type indices._types.AliasDefinition: type: object properties: filter: description: Query used to limit documents the alias can access. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' index_routing: description: 'Value used to route indexing operations to a specific shard. If specified, this overwrites the `routing` value for indexing operations.' type: string is_write_index: description: If `true`, the index is the write index for the alias. default: false type: boolean routing: description: Value used to route indexing and search operations to a specific shard. type: string search_routing: description: 'Value used to route search operations to a specific shard. If specified, this overwrites the `routing` value for search operations.' type: string is_hidden: description: 'If `true`, the alias is hidden. All indices for the alias must have the same `is_hidden` value.' default: false x-state: Generally available; Added in 7.16.0 type: boolean indices._types.TranslogDurability: type: string enum: - request - REQUEST - async - ASYNC _types.aggregations.GeoLinePoint: type: object properties: field: description: The name of the geo_point field. allOf: - $ref: '#/components/schemas/_types.Field' required: - field _types.MergesStats: type: object properties: current: type: number current_docs: type: number current_size: type: string current_size_in_bytes: type: number total: type: number total_auto_throttle: type: string total_auto_throttle_in_bytes: type: number total_docs: type: number total_size: type: string total_size_in_bytes: type: number total_stopped_time: allOf: - $ref: '#/components/schemas/_types.Duration' total_stopped_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' total_throttled_time: allOf: - $ref: '#/components/schemas/_types.Duration' total_throttled_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' total_time: allOf: - $ref: '#/components/schemas/_types.Duration' total_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' required: - current - current_docs - current_size_in_bytes - total - total_auto_throttle_in_bytes - total_docs - total_size_in_bytes - total_stopped_time_in_millis - total_throttled_time_in_millis - total_time_in_millis _types.aggregations.AdjacencyMatrixAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: filters: description: 'Filters used to create buckets. At least one filter is required.' type: object additionalProperties: $ref: '#/components/schemas/_types.query_dsl.QueryContainer' separator: description: Separator used to concatenate filter names. Defaults to &. type: string _types.query_dsl.ScriptQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: script: description: 'Contains a script to run as a query. This script must return a boolean value, `true` or `false`.' allOf: - $ref: '#/components/schemas/_types.Script' required: - script _types.query_dsl.RangeQueryBaseDateMath: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: relation: description: Indicates how the range query matches values for `range` fields. default: intersects allOf: - $ref: '#/components/schemas/_types.query_dsl.RangeRelation' gt: description: Greater than. allOf: - $ref: '#/components/schemas/_types.DateMath' gte: description: Greater than or equal to. allOf: - $ref: '#/components/schemas/_types.DateMath' lt: description: Less than. allOf: - $ref: '#/components/schemas/_types.DateMath' lte: description: Less than or equal to. allOf: - $ref: '#/components/schemas/_types.DateMath' _types.DocStats: type: object properties: count: description: 'Total number of non-deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments and may include documents from nested fields.' type: number deleted: description: 'Total number of deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments. Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged.' type: number total_size_in_bytes: description: 'Returns the total size in bytes of all documents in this stats. This value may be more reliable than store_stats.size_in_bytes in estimating the index size.' type: number total_size: description: Human readable total_size_in_bytes allOf: - $ref: '#/components/schemas/_types.ByteSize' required: - count - total_size_in_bytes indices._types.MappingLimitSettingsTotalFields: type: object properties: limit: description: 'The maximum number of fields in an index. Field and object mappings, as well as field aliases count towards this limit. The limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance degradations and memory issues, especially in clusters with a high load or few resources.' default: '1000' oneOf: - type: number - type: string ignore_dynamic_beyond_limit: description: 'This setting determines what happens when a dynamically mapped field would exceed the total fields limit. When set to false (the default), the index request of the document that tries to add a dynamic field to the mapping will fail with the message Limit of total fields [X] has been exceeded. When set to true, the index request will not fail. Instead, fields that would exceed the limit are not added to the mapping, similar to dynamic: false. The fields that were not added to the mapping will be added to the _ignored field.' default: 'false' oneOf: - type: boolean - type: string indices._types.Merge: type: object properties: scheduler: allOf: - $ref: '#/components/schemas/indices._types.MergeScheduler' indices._types.IndexSettingsUnassignedNodeLeft: type: object properties: delayed_timeout: description: 'The amount of time to wait for a node that has left before assuming its shards are permanently missing and starting to allocate replacement replicas.' default: 1m allOf: - $ref: '#/components/schemas/_types.Duration' _types.mapping.WildcardProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: type: type: string enum: - wildcard null_value: x-state: Generally available; Added in 7.15.0 type: string required: - type _types.query_dsl.RangeQuery: externalDocs: url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-range-query oneOf: - $ref: '#/components/schemas/_types.query_dsl.UntypedRangeQuery' - $ref: '#/components/schemas/_types.query_dsl.DateRangeQuery' - $ref: '#/components/schemas/_types.query_dsl.NumberRangeQuery' - $ref: '#/components/schemas/_types.query_dsl.LongNumberRangeQuery' - $ref: '#/components/schemas/_types.query_dsl.TermRangeQuery' _types.mapping.FloatNumberProperty: allOf: - $ref: '#/components/schemas/_types.mapping.NumberPropertyBase' - type: object properties: type: type: string enum: - float null_value: type: number required: - type _types.mapping.GeoOrientation: type: string enum: - right - RIGHT - counterclockwise - ccw - left - LEFT - clockwise - cw indices.stats.ShardRouting: type: object properties: node: type: string primary: type: boolean relocating_node: oneOf: - type: string - type: - string - 'null' state: allOf: - $ref: '#/components/schemas/indices.stats.ShardRoutingState' required: - node - primary - state _types.Distance: type: string _types.aggregations.TopMetricsValue: type: object properties: field: description: A field to return as a metric. allOf: - $ref: '#/components/schemas/_types.Field' required: - field _types.aggregations.CumulativeSumAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object indices.get_index_template.IndexTemplateItem: type: object properties: name: allOf: - $ref: '#/components/schemas/_types.Name' index_template: allOf: - $ref: '#/components/schemas/indices._types.IndexTemplateWithRollover' required: - name - index_template indices.recovery.ShardRecovery: type: object properties: id: type: number index: allOf: - $ref: '#/components/schemas/indices.recovery.RecoveryIndexStatus' primary: type: boolean source: allOf: - $ref: '#/components/schemas/indices.recovery.RecoveryOrigin' stage: description: The recovery stage. allOf: - $ref: '#/components/schemas/indices.recovery.RecoveryStage' priority: description: The recovery priority. x-state: Generally available; Added in 9.6.0 allOf: - $ref: '#/components/schemas/indices.recovery.RecoveryPriority' start: allOf: - $ref: '#/components/schemas/indices.recovery.RecoveryStartStatus' start_time: allOf: - $ref: '#/components/schemas/_types.DateTime' start_time_in_millis: allOf: - $ref: '#/components/schemas/_types.EpochTimeUnitMillis' stop_time: allOf: - $ref: '#/components/schemas/_types.DateTime' stop_time_in_millis: allOf: - $ref: '#/components/schemas/_types.EpochTimeUnitMillis' target: allOf: - $ref: '#/components/schemas/indices.recovery.RecoveryOrigin' total_time: allOf: - $ref: '#/components/schemas/_types.Duration' total_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' translog: allOf: - $ref: '#/components/schemas/indices.recovery.TranslogStatus' type: description: The recovery source type. allOf: - $ref: '#/components/schemas/indices.recovery.RecoveryType' verify_index: allOf: - $ref: '#/components/schemas/indices.recovery.VerifyIndex' required: - id - index - primary - source - stage - start_time_in_millis - target - total_time_in_millis - translog - type - verify_index _types.analysis.Analyzer: discriminator: propertyName: type mapping: arabic: '#/components/schemas/_types.analysis.ArabicAnalyzer' armenian: '#/components/schemas/_types.analysis.ArmenianAnalyzer' basque: '#/components/schemas/_types.analysis.BasqueAnalyzer' bengali: '#/components/schemas/_types.analysis.BengaliAnalyzer' brazilian: '#/components/schemas/_types.analysis.BrazilianAnalyzer' bulgarian: '#/components/schemas/_types.analysis.BulgarianAnalyzer' catalan: '#/components/schemas/_types.analysis.CatalanAnalyzer' chinese: '#/components/schemas/_types.analysis.ChineseAnalyzer' cjk: '#/components/schemas/_types.analysis.CjkAnalyzer' custom: '#/components/schemas/_types.analysis.CustomAnalyzer' czech: '#/components/schemas/_types.analysis.CzechAnalyzer' danish: '#/components/schemas/_types.analysis.DanishAnalyzer' dutch: '#/components/schemas/_types.analysis.DutchAnalyzer' english: '#/components/schemas/_types.analysis.EnglishAnalyzer' estonian: '#/components/schemas/_types.analysis.EstonianAnalyzer' fingerprint: '#/components/schemas/_types.analysis.FingerprintAnalyzer' finnish: '#/components/schemas/_types.analysis.FinnishAnalyzer' french: '#/components/schemas/_types.analysis.FrenchAnalyzer' galician: '#/components/schemas/_types.analysis.GalicianAnalyzer' german: '#/components/schemas/_types.analysis.GermanAnalyzer' greek: '#/components/schemas/_types.analysis.GreekAnalyzer' hindi: '#/components/schemas/_types.analysis.HindiAnalyzer' hungarian: '#/components/schemas/_types.analysis.HungarianAnalyzer' icu_analyzer: '#/components/schemas/_types.analysis.IcuAnalyzer' indonesian: '#/components/schemas/_types.analysis.IndonesianAnalyzer' irish: '#/components/schemas/_types.analysis.IrishAnalyzer' italian: '#/components/schemas/_types.analysis.ItalianAnalyzer' keyword: '#/components/schemas/_types.analysis.KeywordAnalyzer' kuromoji: '#/components/schemas/_types.analysis.KuromojiAnalyzer' latvian: '#/components/schemas/_types.analysis.LatvianAnalyzer' lithuanian: '#/components/schemas/_types.analysis.LithuanianAnalyzer' nori: '#/components/schemas/_types.analysis.NoriAnalyzer' norwegian: '#/components/schemas/_types.analysis.NorwegianAnalyzer' pattern: '#/components/schemas/_types.analysis.PatternAnalyzer' persian: '#/components/schemas/_types.analysis.PersianAnalyzer' portuguese: '#/components/schemas/_types.analysis.PortugueseAnalyzer' romanian: '#/components/schemas/_types.analysis.RomanianAnalyzer' russian: '#/components/schemas/_types.analysis.RussianAnalyzer' serbian: '#/components/schemas/_types.analysis.SerbianAnalyzer' simple: '#/components/schemas/_types.analysis.SimpleAnalyzer' snowball: '#/components/schemas/_types.analysis.SnowballAnalyzer' sorani: '#/components/schemas/_types.analysis.SoraniAnalyzer' spanish: '#/components/schemas/_types.analysis.SpanishAnalyzer' standard: '#/components/schemas/_types.analysis.StandardAnalyzer' stop: '#/components/schemas/_types.analysis.StopAnalyzer' swedish: '#/components/schemas/_types.analysis.SwedishAnalyzer' thai: '#/components/schemas/_types.analysis.ThaiAnalyzer' turkish: '#/components/schemas/_types.analysis.TurkishAnalyzer' whitespace: '#/components/schemas/_types.analysis.WhitespaceAnalyzer' oneOf: - $ref: '#/components/schemas/_types.analysis.CustomAnalyzer' - $ref: '#/components/schemas/_types.analysis.FingerprintAnalyzer' - $ref: '#/components/schemas/_types.analysis.KeywordAnalyzer' - $ref: '#/components/schemas/_types.analysis.NoriAnalyzer' - $ref: '#/components/schemas/_types.analysis.PatternAnalyzer' - $ref: '#/components/schemas/_types.analysis.SimpleAnalyzer' - $ref: '#/components/schemas/_types.analysis.StandardAnalyzer' - $ref: '#/components/schemas/_types.analysis.StopAnalyzer' - $ref: '#/components/schemas/_types.analysis.WhitespaceAnalyzer' - $ref: '#/components/schemas/_types.analysis.IcuAnalyzer' - $ref: '#/components/schemas/_types.analysis.KuromojiAnalyzer' - $ref: '#/components/schemas/_types.analysis.SnowballAnalyzer' - $ref: '#/components/schemas/_types.analysis.ArabicAnalyzer' - $ref: '#/components/schemas/_types.analysis.ArmenianAnalyzer' - $ref: '#/components/schemas/_types.analysis.BasqueAnalyzer' - $ref: '#/components/schemas/_types.analysis.BengaliAnalyzer' - $ref: '#/components/schemas/_types.analysis.BrazilianAnalyzer' - $ref: '#/components/schemas/_types.analysis.BulgarianAnalyzer' - $ref: '#/components/schemas/_types.analysis.CatalanAnalyzer' - $ref: '#/components/schemas/_types.analysis.ChineseAnalyzer' - $ref: '#/components/schemas/_types.analysis.CjkAnalyzer' - $ref: '#/components/schemas/_types.analysis.CzechAnalyzer' - $ref: '#/components/schemas/_types.analysis.DanishAnalyzer' - $ref: '#/components/schemas/_types.analysis.DutchAnalyzer' - $ref: '#/components/schemas/_types.analysis.EnglishAnalyzer' - $ref: '#/components/schemas/_types.analysis.EstonianAnalyzer' - $ref: '#/components/schemas/_types.analysis.FinnishAnalyzer' - $ref: '#/components/schemas/_types.analysis.FrenchAnalyzer' - $ref: '#/components/schemas/_types.analysis.GalicianAnalyzer' - $ref: '#/components/schemas/_types.analysis.GermanAnalyzer' - $ref: '#/components/schemas/_types.analysis.GreekAnalyzer' - $ref: '#/components/schemas/_types.analysis.HindiAnalyzer' - $ref: '#/components/schemas/_types.analysis.HungarianAnalyzer' - $ref: '#/components/schemas/_types.analysis.IndonesianAnalyzer' - $ref: '#/components/schemas/_types.analysis.IrishAnalyzer' - $ref: '#/components/schemas/_types.analysis.ItalianAnalyzer' - $ref: '#/components/schemas/_types.analysis.LatvianAnalyzer' - $ref: '#/components/schemas/_types.analysis.LithuanianAnalyzer' - $ref: '#/components/schemas/_types.analysis.NorwegianAnalyzer' - $ref: '#/components/schemas/_types.analysis.PersianAnalyzer' - $ref: '#/components/schemas/_types.analysis.PortugueseAnalyzer' - $ref: '#/components/schemas/_types.analysis.RomanianAnalyzer' - $ref: '#/components/schemas/_types.analysis.RussianAnalyzer' - $ref: '#/components/schemas/_types.analysis.SerbianAnalyzer' - $ref: '#/components/schemas/_types.analysis.SoraniAnalyzer' - $ref: '#/components/schemas/_types.analysis.SpanishAnalyzer' - $ref: '#/components/schemas/_types.analysis.SwedishAnalyzer' - $ref: '#/components/schemas/_types.analysis.TurkishAnalyzer' - $ref: '#/components/schemas/_types.analysis.ThaiAnalyzer' _types.DurationValueUnitMillis: allOf: - $ref: '#/components/schemas/_types.UnitMillis' _types.aggregations.GeoTileGridAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: field: description: 'Field containing indexed `geo_point` or `geo_shape` values. If the field contains an array, `geotile_grid` aggregates all array values.' allOf: - $ref: '#/components/schemas/_types.Field' precision: description: 'Integer zoom of the key used to define cells/buckets in the results. Values outside of the range [0,29] will be rejected.' default: '7' allOf: - $ref: '#/components/schemas/_types.GeoTilePrecision' shard_size: description: 'Allows for more accurate counting of the top cells returned in the final result the aggregation. Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard.' type: number size: description: The maximum number of buckets to return. default: 10000.0 type: number bounds: description: A bounding box to filter the geo-points or geo-shapes in each bucket. allOf: - $ref: '#/components/schemas/_types.GeoBounds' _types.mapping.SourceField: type: object properties: enabled: type: boolean excludes: type: array items: type: string includes: type: array items: type: string mode: allOf: - $ref: '#/components/schemas/_types.mapping.SourceFieldMode' _types.analysis.TokenFilterBase: type: object properties: version: allOf: - $ref: '#/components/schemas/_types.VersionString' _types.query_dsl.DecayFunctionBase: type: object properties: multi_value_mode: description: Determines how the distance is calculated when a field used for computing the decay contains multiple values. default: min allOf: - $ref: '#/components/schemas/_types.query_dsl.MultiValueMode' _types.query_dsl.GeoDistanceFeatureQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.DistanceFeatureQueryBaseGeoLocationDistance' - type: object _global.search._types.HighlighterFragmenter: type: string enum: - simple - span _types.mapping.Murmur3HashProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: type: type: string enum: - murmur3 required: - type _types.FieldValue: description: A field value. oneOf: - type: number - type: number - type: string - type: boolean - type: - string - 'null' _types.analysis.ArabicNormalizationTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - arabic_normalization required: - type _types.RankContainer: type: object properties: rrf: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/reciprocal-rank-fusion description: The reciprocal rank fusion parameters allOf: - $ref: '#/components/schemas/_types.RrfRank' minProperties: 1 maxProperties: 1 _types.query_dsl.IntervalsPrefix: type: object properties: analyzer: description: Analyzer used to analyze the `prefix`. type: string prefix: description: Beginning characters of terms you wish to find in the top-level field. type: string use_field: description: 'If specified, match intervals from this field rather than the top-level field. The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.' allOf: - $ref: '#/components/schemas/_types.Field' required: - prefix _types.mapping.LongNumberProperty: allOf: - $ref: '#/components/schemas/_types.mapping.NumberPropertyBase' - type: object properties: type: type: string enum: - long null_value: type: number required: - type _types.aggregations.BucketAggregationBase: description: Base type for bucket aggregations. These aggregations also accept sub-aggregations. allOf: - $ref: '#/components/schemas/_types.aggregations.Aggregation' - type: object _types.aggregations.ChiSquareHeuristic: type: object properties: background_is_superset: description: Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. type: boolean include_negatives: description: Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset. type: boolean required: - background_is_superset - include_negatives _types.mapping.IntegerRangeProperty: allOf: - $ref: '#/components/schemas/_types.mapping.RangePropertyBase' - type: object properties: type: type: string enum: - integer_range required: - type indices._types.SegmentSortOrder: type: string enum: - asc - ASC - desc - DESC indices.reload_search_analyzers.ReloadResult: type: object properties: reload_details: type: array items: $ref: '#/components/schemas/indices.reload_search_analyzers.ReloadDetails' _shards: allOf: - $ref: '#/components/schemas/_types.ShardStatistics' required: - reload_details - _shards indices.resolve_index.ResolveIndexItem: type: object properties: name: allOf: - $ref: '#/components/schemas/_types.Name' aliases: type: array items: type: string attributes: type: array items: type: string data_stream: allOf: - $ref: '#/components/schemas/_types.DataStreamName' mode: allOf: - $ref: '#/components/schemas/indices._types.IndexMode' required: - name - attributes indices._types.DataStreamLifecycleWithRollover: description: 'Data stream lifecycle with rollover can be used to display the configuration including the default rollover conditions, if asked.' allOf: - $ref: '#/components/schemas/indices._types.DataStreamLifecycle' - type: object properties: rollover: description: 'The conditions which will trigger the rollover of a backing index as configured by the cluster setting `cluster.lifecycle.default.rollover`. This property is an implementation detail and it will only be retrieved when the query param `include_defaults` is set to true. The contents of this field are subject to change.' allOf: - $ref: '#/components/schemas/indices._types.DataStreamLifecycleRolloverConditions' _global.search._types.PointInTimeReference: type: object properties: id: allOf: - $ref: '#/components/schemas/_types.Id' keep_alive: allOf: - $ref: '#/components/schemas/_types.Duration' required: - id indices.add_block.AddIndicesBlockStatus: type: object properties: name: allOf: - $ref: '#/components/schemas/_types.IndexName' blocked: type: boolean required: - name - blocked indices.analyze.TextToAnalyze: oneOf: - type: string - type: array items: type: string _types.mapping.DocValuesPropertyBase: allOf: - $ref: '#/components/schemas/_types.mapping.CorePropertyBase' - type: object properties: doc_values: allOf: - $ref: '#/components/schemas/_types.mapping.DocValues' _types.mapping.IpRangeProperty: allOf: - $ref: '#/components/schemas/_types.mapping.RangePropertyBase' - type: object properties: type: type: string enum: - ip_range required: - type _types.PipelineName: type: string _types.analysis.LowercaseTokenizer: allOf: - $ref: '#/components/schemas/_types.analysis.TokenizerBase' - type: object properties: type: type: string enum: - lowercase required: - type _types.query_dsl.MoreLikeThisQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: analyzer: externalDocs: url: https://www.elastic.co/docs/manage-data/data-store/text-analysis description: 'The analyzer that is used to analyze the free form text. Defaults to the analyzer associated with the first field in fields.' type: string boost_terms: description: 'Each term in the formed query could be further boosted by their tf-idf score. This sets the boost factor to use when using this feature. Defaults to deactivated (0).' default: 0.0 type: number fail_on_unsupported_field: description: Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (`text` or `keyword`). default: true type: boolean fields: description: 'A list of fields to fetch and analyze the text from. Defaults to the `index.query.default_field` index setting, which has a default value of `*`.' type: array items: $ref: '#/components/schemas/_types.Field' include: description: Specifies whether the input documents should also be included in the search results returned. default: false type: boolean like: description: Specifies free form text and/or a single or multiple documents for which you want to find similar documents. oneOf: - $ref: '#/components/schemas/_types.query_dsl.Like' - type: array items: $ref: '#/components/schemas/_types.query_dsl.Like' max_doc_freq: description: The maximum document frequency above which the terms are ignored from the input document. type: number max_query_terms: description: The maximum number of query terms that can be selected. default: 25.0 type: number max_word_length: description: 'The maximum word length above which the terms are ignored. Defaults to unbounded (`0`).' default: 0.0 type: number min_doc_freq: description: The minimum document frequency below which the terms are ignored from the input document. default: 5.0 type: number minimum_should_match: description: After the disjunctive query has been formed, this parameter controls the number of terms that must match. allOf: - $ref: '#/components/schemas/_types.MinimumShouldMatch' min_term_freq: description: The minimum term frequency below which the terms are ignored from the input document. default: 2.0 type: number min_word_length: description: The minimum word length below which the terms are ignored. default: 0.0 type: number routing: type: string stop_words: description: 'An array of stop words. Any word in this set is ignored.' allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' unlike: description: Used in combination with `like` to exclude documents that match a set of terms. oneOf: - $ref: '#/components/schemas/_types.query_dsl.Like' - type: array items: $ref: '#/components/schemas/_types.query_dsl.Like' version: allOf: - $ref: '#/components/schemas/_types.VersionNumber' version_type: default: '''internal''' allOf: - $ref: '#/components/schemas/_types.VersionType' required: - like indices._types.IndexRoutingAllocationOptions: type: string enum: - all - primaries - new_primaries - none _types.aggregations.CompositeTermsAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.CompositeAggregationBase' - type: object _types.query_dsl.RankFeatureFunctionSigmoid: allOf: - $ref: '#/components/schemas/_types.query_dsl.RankFeatureFunction' - type: object properties: pivot: description: Configurable pivot value so that the result will be less than 0.5. type: number exponent: description: Configurable Exponent. type: number required: - pivot - exponent indices.segments.ShardSegmentRouting: type: object properties: node: description: The node ID of the node that holds the shard. type: string primary: description: If `true`, the shard is a primary shard. type: boolean state: description: The state of the shard, such as `STARTED` or `RELOCATING`. type: string required: - node - primary - state _types.RescoreVector: type: object properties: oversample: description: Applies the specified oversample factor to k on the approximate kNN search type: number required: - oversample _types.aggregations.TermsAggregationCollectMode: type: string enum: - depth_first - breadth_first _types.analysis.NoriDecompoundMode: type: string enum: - discard - none - mixed indices.stats.ShardPath: type: object properties: data_path: type: string is_custom_data_path: type: boolean state_path: type: string required: - data_path - is_custom_data_path - state_path _types.aggregations.WeightedAverageAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.Aggregation' - type: object properties: format: description: A numeric response formatter. type: string value: description: Configuration for the field that provides the values. allOf: - $ref: '#/components/schemas/_types.aggregations.WeightedAverageValue' value_type: allOf: - $ref: '#/components/schemas/_types.aggregations.ValueType' weight: description: Configuration for the field or script that provides the weights. allOf: - $ref: '#/components/schemas/_types.aggregations.WeightedAverageValue' _types.AcknowledgedResponseBase: type: object properties: acknowledged: description: For a successful response, this value is always true. On failure, an exception is returned instead. type: boolean required: - acknowledged _types.analysis.SnowballLanguage: type: string enum: - Arabic - Armenian - Basque - Catalan - Danish - Dutch - English - Estonian - Finnish - French - German - German2 - Hungarian - Italian - Irish - Kp - Lithuanian - Lovins - Norwegian - Porter - Portuguese - Romanian - Russian - Serbian - Spanish - Swedish - Turkish _types.query_dsl.Like: description: Text that we want similar documents for or a lookup to a document's field for the text. oneOf: - type: string - $ref: '#/components/schemas/_types.query_dsl.LikeDocument' _types.aggregations.AggregationContainer: allOf: - type: object properties: aggregations: description: 'Sub-aggregations for this aggregation. Only applies to bucket aggregations.' type: object additionalProperties: $ref: '#/components/schemas/_types.aggregations.AggregationContainer' meta: allOf: - $ref: '#/components/schemas/_types.Metadata' - type: object properties: adjacency_matrix: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-adjacency-matrix-aggregation description: 'A bucket aggregation returning a form of adjacency matrix. The request provides a collection of named filter expressions, similar to the `filters` aggregation. Each bucket in the response represents a non-empty cell in the matrix of intersecting filters.' allOf: - $ref: '#/components/schemas/_types.aggregations.AdjacencyMatrixAggregation' auto_date_histogram: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-autodatehistogram-aggregation description: A multi-bucket aggregation similar to the date histogram, except instead of providing an interval to use as the width of each bucket, a target number of buckets is provided. allOf: - $ref: '#/components/schemas/_types.aggregations.AutoDateHistogramAggregation' avg: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-avg-aggregation description: A single-value metrics aggregation that computes the average of numeric values that are extracted from the aggregated documents. allOf: - $ref: '#/components/schemas/_types.aggregations.AverageAggregation' avg_bucket: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-avg-bucket-aggregation description: 'A sibling pipeline aggregation which calculates the mean value of a specified metric in a sibling aggregation. The specified metric must be numeric and the sibling aggregation must be a multi-bucket aggregation.' allOf: - $ref: '#/components/schemas/_types.aggregations.AverageBucketAggregation' boxplot: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-boxplot-aggregation description: A metrics aggregation that computes a box plot of numeric values extracted from the aggregated documents. allOf: - $ref: '#/components/schemas/_types.aggregations.BoxplotAggregation' bucket_script: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-script-aggregation description: A parent pipeline aggregation which runs a script which can perform per bucket computations on metrics in the parent multi-bucket aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.BucketScriptAggregation' bucket_selector: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-selector-aggregation description: A parent pipeline aggregation which runs a script to determine whether the current bucket will be retained in the parent multi-bucket aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.BucketSelectorAggregation' bucket_sort: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-sort-aggregation description: A parent pipeline aggregation which sorts the buckets of its parent multi-bucket aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.BucketSortAggregation' bucket_count_ks_test: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-count-ks-test-aggregation description: A sibling pipeline aggregation which runs a two sample Kolmogorov–Smirnov test ("K-S test") against a provided distribution and the distribution implied by the documents counts in the configured sibling aggregation. x-state: Experimental allOf: - $ref: '#/components/schemas/_types.aggregations.BucketKsAggregation' bucket_correlation: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-correlation-aggregation description: A sibling pipeline aggregation which runs a correlation function on the configured sibling multi-bucket aggregation. x-state: Experimental allOf: - $ref: '#/components/schemas/_types.aggregations.BucketCorrelationAggregation' cardinality: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-cardinality-aggregation description: A single-value metrics aggregation that calculates an approximate count of distinct values. allOf: - $ref: '#/components/schemas/_types.aggregations.CardinalityAggregation' cartesian_bounds: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-cartesian-bounds-aggregation description: A metric aggregation that computes the spatial bounding box containing all values for a Point or Shape field. allOf: - $ref: '#/components/schemas/_types.aggregations.CartesianBoundsAggregation' cartesian_centroid: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-cartesian-centroid-aggregation description: A metric aggregation that computes the weighted centroid from all coordinate values for point and shape fields. allOf: - $ref: '#/components/schemas/_types.aggregations.CartesianCentroidAggregation' categorize_text: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-categorize-text-aggregation description: A multi-bucket aggregation that groups semi-structured text into buckets. x-state: Experimental allOf: - $ref: '#/components/schemas/_types.aggregations.CategorizeTextAggregation' change_point: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-change-point-aggregation description: 'A sibling pipeline that detects, spikes, dips, and change points in a metric. Given a distribution of values provided by the sibling multi-bucket aggregation, this aggregation indicates the bucket of any spike or dip and/or the bucket at which the largest change in the distribution of values, if they are statistically significant. There must be at least 22 bucketed values. Fewer than 1,000 is preferred.' allOf: - $ref: '#/components/schemas/_types.aggregations.ChangePointAggregation' children: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-children-aggregation description: A single bucket aggregation that selects child documents that have the specified type, as defined in a `join` field. allOf: - $ref: '#/components/schemas/_types.aggregations.ChildrenAggregation' composite: description: 'A multi-bucket aggregation that creates composite buckets from different sources. Unlike the other multi-bucket aggregations, you can use the `composite` aggregation to paginate *all* buckets from a multi-level aggregation efficiently.' allOf: - $ref: '#/components/schemas/_types.aggregations.CompositeAggregation' cumulative_cardinality: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-cumulative-cardinality-aggregation description: A parent pipeline aggregation which calculates the cumulative cardinality in a parent `histogram` or `date_histogram` aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.CumulativeCardinalityAggregation' cumulative_sum: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-cumulative-sum-aggregation description: A parent pipeline aggregation which calculates the cumulative sum of a specified metric in a parent `histogram` or `date_histogram` aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.CumulativeSumAggregation' date_histogram: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-datehistogram-aggregation description: 'A multi-bucket values source based aggregation that can be applied on date values or date range values extracted from the documents. It dynamically builds fixed size (interval) buckets over the values.' allOf: - $ref: '#/components/schemas/_types.aggregations.DateHistogramAggregation' date_range: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-daterange-aggregation description: A multi-bucket value source based aggregation that enables the user to define a set of date ranges - each representing a bucket. allOf: - $ref: '#/components/schemas/_types.aggregations.DateRangeAggregation' derivative: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-derivative-aggregation description: A parent pipeline aggregation which calculates the derivative of a specified metric in a parent `histogram` or `date_histogram` aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.DerivativeAggregation' diversified_sampler: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-diversified-sampler-aggregation description: 'A filtering aggregation used to limit any sub aggregations'' processing to a sample of the top-scoring documents. Similar to the `sampler` aggregation, but adds the ability to limit the number of matches that share a common value.' allOf: - $ref: '#/components/schemas/_types.aggregations.DiversifiedSamplerAggregation' extended_stats: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-extendedstats-aggregation description: A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents. allOf: - $ref: '#/components/schemas/_types.aggregations.ExtendedStatsAggregation' extended_stats_bucket: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-extended-stats-bucket-aggregation description: A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.ExtendedStatsBucketAggregation' frequent_item_sets: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-frequent-item-sets-aggregation description: A bucket aggregation which finds frequent item sets, a form of association rules mining that identifies items that often occur together. allOf: - $ref: '#/components/schemas/_types.aggregations.FrequentItemSetsAggregation' filter: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filter-aggregation description: A single bucket aggregation that narrows the set of documents to those that match a query. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' filters: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filters-aggregation description: A multi-bucket aggregation where each bucket contains the documents that match a query. allOf: - $ref: '#/components/schemas/_types.aggregations.FiltersAggregation' geo_bounds: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geobounds-aggregation description: A metric aggregation that computes the geographic bounding box containing all values for a Geopoint or Geoshape field. allOf: - $ref: '#/components/schemas/_types.aggregations.GeoBoundsAggregation' geo_centroid: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geocentroid-aggregation description: A metric aggregation that computes the weighted centroid from all coordinate values for geo fields. allOf: - $ref: '#/components/schemas/_types.aggregations.GeoCentroidAggregation' geo_distance: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geodistance-aggregation description: 'A multi-bucket aggregation that works on `geo_point` fields. Evaluates the distance of each document value from an origin point and determines the buckets it belongs to, based on ranges defined in the request.' allOf: - $ref: '#/components/schemas/_types.aggregations.GeoDistanceAggregation' geohash_grid: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geohashgrid-aggregation description: 'A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid. Each cell is labeled using a geohash which is of user-definable precision.' allOf: - $ref: '#/components/schemas/_types.aggregations.GeoHashGridAggregation' geo_line: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geo-line description: Aggregates all `geo_point` values within a bucket into a `LineString` ordered by the chosen sort field. allOf: - $ref: '#/components/schemas/_types.aggregations.GeoLineAggregation' geotile_grid: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geotilegrid-aggregation description: 'A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid. Each cell corresponds to a map tile as used by many online map sites.' allOf: - $ref: '#/components/schemas/_types.aggregations.GeoTileGridAggregation' geohex_grid: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geohexgrid-aggregation description: 'A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid. Each cell corresponds to a H3 cell index and is labeled using the H3Index representation.' allOf: - $ref: '#/components/schemas/_types.aggregations.GeohexGridAggregation' global: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-global-aggregation description: 'Defines a single bucket of all the documents within the search execution context. This context is defined by the indices and the document types you’re searching on, but is not influenced by the search query itself.' allOf: - $ref: '#/components/schemas/_types.aggregations.GlobalAggregation' histogram: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-histogram-aggregation description: 'A multi-bucket values source based aggregation that can be applied on numeric values or numeric range values extracted from the documents. It dynamically builds fixed size (interval) buckets over the values.' allOf: - $ref: '#/components/schemas/_types.aggregations.HistogramAggregation' ip_range: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-iprange-aggregation description: A multi-bucket value source based aggregation that enables the user to define a set of IP ranges - each representing a bucket. allOf: - $ref: '#/components/schemas/_types.aggregations.IpRangeAggregation' ip_prefix: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-ipprefix-aggregation description: A bucket aggregation that groups documents based on the network or sub-network of an IP address. allOf: - $ref: '#/components/schemas/_types.aggregations.IpPrefixAggregation' inference: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-inference-bucket-aggregation description: A parent pipeline aggregation which loads a pre-trained model and performs inference on the collated result fields from the parent bucket aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.InferenceAggregation' line: allOf: - $ref: '#/components/schemas/_types.aggregations.GeoLineAggregation' matrix_stats: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-matrix-stats-aggregation description: 'A numeric aggregation that computes the following statistics over a set of document fields: `count`, `mean`, `variance`, `skewness`, `kurtosis`, `covariance`, and `covariance`.' allOf: - $ref: '#/components/schemas/_types.aggregations.MatrixStatsAggregation' max: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-max-aggregation description: A single-value metrics aggregation that returns the maximum value among the numeric values extracted from the aggregated documents. allOf: - $ref: '#/components/schemas/_types.aggregations.MaxAggregation' max_bucket: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-max-bucket-aggregation description: A sibling pipeline aggregation which identifies the bucket(s) with the maximum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s). allOf: - $ref: '#/components/schemas/_types.aggregations.MaxBucketAggregation' median_absolute_deviation: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-median-absolute-deviation-aggregation description: A single-value aggregation that approximates the median absolute deviation of its search results. allOf: - $ref: '#/components/schemas/_types.aggregations.MedianAbsoluteDeviationAggregation' min: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-min-aggregation description: A single-value metrics aggregation that returns the minimum value among numeric values extracted from the aggregated documents. allOf: - $ref: '#/components/schemas/_types.aggregations.MinAggregation' min_bucket: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-min-bucket-aggregation description: A sibling pipeline aggregation which identifies the bucket(s) with the minimum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s). allOf: - $ref: '#/components/schemas/_types.aggregations.MinBucketAggregation' missing: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-missing-aggregation description: A field data based single bucket aggregation, that creates a bucket of all documents in the current document set context that are missing a field value (effectively, missing a field or having the configured NULL value set). allOf: - $ref: '#/components/schemas/_types.aggregations.MissingAggregation' moving_avg: allOf: - $ref: '#/components/schemas/_types.aggregations.MovingAverageAggregation' moving_percentiles: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-moving-percentiles-aggregation description: Given an ordered series of percentiles, "slides" a window across those percentiles and computes cumulative percentiles. allOf: - $ref: '#/components/schemas/_types.aggregations.MovingPercentilesAggregation' moving_fn: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-movfn-aggregation description: 'Given an ordered series of data, "slides" a window across the data and runs a custom script on each window of data. For convenience, a number of common functions are predefined such as `min`, `max`, and moving averages.' allOf: - $ref: '#/components/schemas/_types.aggregations.MovingFunctionAggregation' multi_terms: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-multi-terms-aggregation description: A multi-bucket value source based aggregation where buckets are dynamically built - one per unique set of values. allOf: - $ref: '#/components/schemas/_types.aggregations.MultiTermsAggregation' nested: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-nested-aggregation description: A special single bucket aggregation that enables aggregating nested documents. allOf: - $ref: '#/components/schemas/_types.aggregations.NestedAggregation' normalize: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-normalize-aggregation description: A parent pipeline aggregation which calculates the specific normalized/rescaled value for a specific bucket value. allOf: - $ref: '#/components/schemas/_types.aggregations.NormalizeAggregation' parent: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-parent-aggregation description: A special single bucket aggregation that selects parent documents that have the specified type, as defined in a `join` field. allOf: - $ref: '#/components/schemas/_types.aggregations.ParentAggregation' percentile_ranks: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-percentile-rank-aggregation description: A multi-value metrics aggregation that calculates one or more percentile ranks over numeric values extracted from the aggregated documents. allOf: - $ref: '#/components/schemas/_types.aggregations.PercentileRanksAggregation' percentiles: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-percentile-aggregation description: A multi-value metrics aggregation that calculates one or more percentiles over numeric values extracted from the aggregated documents. allOf: - $ref: '#/components/schemas/_types.aggregations.PercentilesAggregation' percentiles_bucket: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-percentiles-bucket-aggregation description: A sibling pipeline aggregation which calculates percentiles across all bucket of a specified metric in a sibling aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.PercentilesBucketAggregation' range: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-range-aggregation description: A multi-bucket value source based aggregation that enables the user to define a set of ranges - each representing a bucket. allOf: - $ref: '#/components/schemas/_types.aggregations.RangeAggregation' rare_terms: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-rare-terms-aggregation description: A multi-bucket value source based aggregation which finds "rare" terms — terms that are at the long-tail of the distribution and are not frequent. allOf: - $ref: '#/components/schemas/_types.aggregations.RareTermsAggregation' rate: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-rate-aggregation description: 'Calculates a rate of documents or a field in each bucket. Can only be used inside a `date_histogram` or `composite` aggregation.' allOf: - $ref: '#/components/schemas/_types.aggregations.RateAggregation' reverse_nested: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-reverse-nested-aggregation description: 'A special single bucket aggregation that enables aggregating on parent documents from nested documents. Should only be defined inside a `nested` aggregation.' allOf: - $ref: '#/components/schemas/_types.aggregations.ReverseNestedAggregation' random_sampler: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-random-sampler-aggregation description: 'A single bucket aggregation that randomly includes documents in the aggregated results. Sampling provides significant speed improvement at the cost of accuracy.' x-state: Experimental; Added in 8.1.0 allOf: - $ref: '#/components/schemas/_types.aggregations.RandomSamplerAggregation' sampler: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-sampler-aggregation description: A filtering aggregation used to limit any sub aggregations' processing to a sample of the top-scoring documents. allOf: - $ref: '#/components/schemas/_types.aggregations.SamplerAggregation' scripted_metric: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-scripted-metric-aggregation description: A metric aggregation that uses scripts to provide a metric output. allOf: - $ref: '#/components/schemas/_types.aggregations.ScriptedMetricAggregation' serial_diff: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-serialdiff-aggregation description: An aggregation that subtracts values in a time series from themselves at different time lags or periods. allOf: - $ref: '#/components/schemas/_types.aggregations.SerialDifferencingAggregation' significant_terms: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significantterms-aggregation description: Returns interesting or unusual occurrences of terms in a set. allOf: - $ref: '#/components/schemas/_types.aggregations.SignificantTermsAggregation' significant_text: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significanttext-aggregation description: Returns interesting or unusual occurrences of free-text terms in a set. allOf: - $ref: '#/components/schemas/_types.aggregations.SignificantTextAggregation' stats: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-stats-aggregation description: A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents. allOf: - $ref: '#/components/schemas/_types.aggregations.StatsAggregation' stats_bucket: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-stats-bucket-aggregation description: A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.StatsBucketAggregation' string_stats: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-string-stats-aggregation description: A multi-value metrics aggregation that computes statistics over string values extracted from the aggregated documents. allOf: - $ref: '#/components/schemas/_types.aggregations.StringStatsAggregation' sum: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-sum-aggregation description: A single-value metrics aggregation that sums numeric values that are extracted from the aggregated documents. allOf: - $ref: '#/components/schemas/_types.aggregations.SumAggregation' sum_bucket: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-sum-bucket-aggregation description: A sibling pipeline aggregation which calculates the sum of a specified metric across all buckets in a sibling aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.SumBucketAggregation' terms: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-terms-aggregation description: A multi-bucket value source based aggregation where buckets are dynamically built - one per unique value. allOf: - $ref: '#/components/schemas/_types.aggregations.TermsAggregation' time_series: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-time-series-aggregation description: 'The time series aggregation queries data created using a time series index. This is typically data such as metrics or other data streams with a time component, and requires creating an index using the time series mode.' x-state: Experimental allOf: - $ref: '#/components/schemas/_types.aggregations.TimeSeriesAggregation' top_hits: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-top-hits-aggregation description: A metric aggregation that returns the top matching documents per bucket. allOf: - $ref: '#/components/schemas/_types.aggregations.TopHitsAggregation' t_test: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-ttest-aggregation description: A metrics aggregation that performs a statistical hypothesis test in which the test statistic follows a Student’s t-distribution under the null hypothesis on numeric values extracted from the aggregated documents. allOf: - $ref: '#/components/schemas/_types.aggregations.TTestAggregation' top_metrics: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-top-metrics description: A metric aggregation that selects metrics from the document with the largest or smallest sort value. allOf: - $ref: '#/components/schemas/_types.aggregations.TopMetricsAggregation' value_count: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-valuecount-aggregation description: A single-value metrics aggregation that counts the number of values that are extracted from the aggregated documents. allOf: - $ref: '#/components/schemas/_types.aggregations.ValueCountAggregation' weighted_avg: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-weight-avg-aggregation description: A single-value metrics aggregation that computes the weighted average of numeric values that are extracted from the aggregated documents. allOf: - $ref: '#/components/schemas/_types.aggregations.WeightedAverageAggregation' variable_width_histogram: externalDocs: url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-variablewidthhistogram-aggregation description: A multi-bucket aggregation similar to the histogram, except instead of providing an interval to use as the width of each bucket, a target number of buckets is provided. allOf: - $ref: '#/components/schemas/_types.aggregations.VariableWidthHistogramAggregation' minProperties: 1 maxProperties: 1 _types.RRFRetrieverEntry: description: Either a direct RetrieverContainer (backward compatible) or an RRFRetrieverComponent with weight. oneOf: - $ref: '#/components/schemas/_types.RetrieverContainer' - $ref: '#/components/schemas/_types.RRFRetrieverComponent' _types.MinimumShouldMatch: description: The minimum number of terms that should match as integer, percentage or range oneOf: - type: number - type: string _types.aggregations.FrequentItemSetsField: type: object properties: field: allOf: - $ref: '#/components/schemas/_types.Field' exclude: description: 'Values to exclude. Can be regular expression strings or arrays of strings of exact terms.' allOf: - $ref: '#/components/schemas/_types.aggregations.TermsExclude' include: description: 'Values to include. Can be regular expression strings or arrays of strings of exact terms.' allOf: - $ref: '#/components/schemas/_types.aggregations.TermsInclude' required: - field indices._types.TemplateMapping: type: object properties: aliases: type: object additionalProperties: $ref: '#/components/schemas/indices._types.Alias' index_patterns: type: array items: $ref: '#/components/schemas/_types.Name' mappings: allOf: - $ref: '#/components/schemas/_types.mapping.TypeMapping' order: type: number settings: type: object additionalProperties: type: object version: allOf: - $ref: '#/components/schemas/_types.VersionNumber' required: - aliases - index_patterns - mappings - order - settings _types.aggregations.CategorizeTextAnalyzer: oneOf: - type: string - $ref: '#/components/schemas/_types.aggregations.CustomCategorizeTextAnalyzer' _types.query_dsl.ScriptScoreQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: min_score: description: Documents with a score lower than this floating point number are excluded from the search results. type: number query: description: Query used to return documents. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' script: description: 'Script used to compute the score of documents returned by the query. Important: final relevance scores from the `script_score` query cannot be negative.' allOf: - $ref: '#/components/schemas/_types.Script' required: - query - script _types.mapping.DenseVectorIndexOptions: type: object properties: confidence_interval: description: 'The confidence interval to use when quantizing the vectors. Can be any value between and including `0.90` and `1.0` or exactly `0`. When the value is `0`, this indicates that dynamic quantiles should be calculated for optimized quantization. When between `0.90` and `1.0`, this value restricts the values used when calculating the quantization thresholds. For example, a value of `0.95` will only use the middle `95%` of the values when calculating the quantization thresholds (e.g. the highest and lowest `2.5%` of values will be ignored). Defaults to `1/(dims + 1)` for `int8` quantized vectors and `0` for `int4` for dynamic quantile calculation. Only applicable to `int8_hnsw`, `int4_hnsw`, `int8_flat`, and `int4_flat` index types.' type: number ef_construction: description: 'The number of candidates to track while assembling the list of nearest neighbors for each new node. Only applicable to `hnsw`, `int8_hnsw`, `bbq_hnsw`, and `int4_hnsw` index types.' default: 100.0 type: number m: description: 'The number of neighbors each node will be connected to in the HNSW graph. Only applicable to `hnsw`, `int8_hnsw`, `bbq_hnsw`, and `int4_hnsw` index types.' default: 16.0 type: number type: description: The type of kNN algorithm to use. allOf: - $ref: '#/components/schemas/_types.mapping.DenseVectorIndexOptionsType' rescore_vector: description: The rescore vector options. This is only applicable to `bbq_disk`, `bbq_hnsw`, `int4_hnsw`, `int8_hnsw`, `bbq_flat`, `int4_flat`, and `int8_flat` index types. allOf: - $ref: '#/components/schemas/_types.mapping.DenseVectorIndexOptionsRescoreVector' on_disk_rescore: description: '`true` if vector rescoring should be done on-disk Only applicable to `bbq_disk`, `bbq_hnsw`, `int4_hnsw`, `int8_hnsw`' default: false x-state: Experimental; Added in 9.3.0 type: boolean flat_index_threshold: description: 'The segment document count threshold below which HNSW graph construction is skipped in favor of brute-force flat search. `-1` (default) defers to format defaults: `300` for `bbq_hnsw`, `150` for `hnsw`, `int8_hnsw`, and `int4_hnsw`. `0` always builds the graph. A positive value overrides the format default. Only applicable to `hnsw`, `int8_hnsw`, `int4_hnsw`, and `bbq_hnsw` index types.' default: -1.0 x-state: Generally available; Added in 9.4.0 type: number required: - type _types.aggregations.ReverseNestedAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: path: description: 'Defines the nested object field that should be joined back to. The default is empty, which means that it joins back to the root/main document level.' allOf: - $ref: '#/components/schemas/_types.Field' indices._types.IndexTemplateWithRollover: type: object properties: template: description: 'Template to be applied. It may optionally include an `aliases`, `mappings`, or `settings` configuration.' allOf: - $ref: '#/components/schemas/indices._types.IndexTemplateSummaryWithRollover' index_patterns: description: Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation. allOf: - $ref: '#/components/schemas/_types.Names' composed_of: description: 'An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.' type: array items: $ref: '#/components/schemas/_types.Name' version: description: 'Version number used to manage index templates externally. This number is not automatically generated by Elasticsearch.' allOf: - $ref: '#/components/schemas/_types.VersionNumber' priority: description: 'Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by Elasticsearch.' type: number _meta: description: 'Optional user metadata about the index template. May have any contents. This map is not automatically generated by Elasticsearch.' allOf: - $ref: '#/components/schemas/_types.Metadata' allow_auto_create: type: boolean data_stream: description: 'If this object is included, the template is used to create data streams and their backing indices. Supports an empty object. Data streams require a matching index template with a `data_stream` object.' allOf: - $ref: '#/components/schemas/indices._types.IndexTemplateDataStreamConfiguration' deprecated: description: 'Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning.' x-state: Generally available; Added in 8.12.0 type: boolean ignore_missing_component_templates: description: A list of component template names that are allowed to be absent. x-state: Generally available; Added in 8.7.0 allOf: - $ref: '#/components/schemas/_types.Names' created_date: description: Date and time when the index template was created. Only returned if the `human` query parameter is `true`. x-state: Generally available; Added in 9.2.0 allOf: - $ref: '#/components/schemas/_types.DateTime' created_date_millis: description: Date and time when the index template was created, in milliseconds since the epoch. x-state: Generally available; Added in 9.2.0 allOf: - $ref: '#/components/schemas/_types.EpochTimeUnitMillis' modified_date: description: Date and time when the index template was last modified. Only returned if the `human` query parameter is `true`. x-state: Generally available; Added in 9.2.0 allOf: - $ref: '#/components/schemas/_types.DateTime' modified_date_millis: description: Date and time when the index template was last modified, in milliseconds since the epoch. x-state: Generally available; Added in 9.2.0 allOf: - $ref: '#/components/schemas/_types.EpochTimeUnitMillis' required: - index_patterns - composed_of _types.Percentage: oneOf: - type: string - type: number _types.analysis.Tokenizer: externalDocs: url: https://www.elastic.co/docs/reference/text-analysis/tokenizer-reference oneOf: - type: string - $ref: '#/components/schemas/_types.analysis.TokenizerDefinition' _types.aggregations.GeoHashGridAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: bounds: description: The bounding box to filter the points in each bucket. allOf: - $ref: '#/components/schemas/_types.GeoBounds' field: description: 'Field containing indexed `geo_point` or `geo_shape` values. If the field contains an array, `geohash_grid` aggregates all array values.' allOf: - $ref: '#/components/schemas/_types.Field' precision: description: The string length of the geohashes used to define cells/buckets in the results. default: '5' allOf: - $ref: '#/components/schemas/_types.GeoHashPrecision' shard_size: description: 'Allows for more accurate counting of the top cells returned in the final result the aggregation. Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard.' type: number size: description: The maximum number of geohash buckets to return. default: 10000.0 type: number cluster._types.ComponentTemplate: type: object properties: name: allOf: - $ref: '#/components/schemas/_types.Name' component_template: allOf: - $ref: '#/components/schemas/cluster._types.ComponentTemplateNodeWithRollover' required: - name - component_template _types.query_dsl.NestedQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: ignore_unmapped: description: Indicates whether to ignore an unmapped path and not return any documents instead of an error. default: false type: boolean inner_hits: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-inner-hits description: If defined, each search hit will contain inner hits. allOf: - $ref: '#/components/schemas/_global.search._types.InnerHits' path: description: Path to the nested object you wish to search. allOf: - $ref: '#/components/schemas/_types.Field' query: description: Query you wish to run on nested objects in the path. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' score_mode: description: How scores for matching child objects affect the root parent document’s relevance score. default: '''avg''' allOf: - $ref: '#/components/schemas/_types.query_dsl.ChildScoreMode' required: - path - query _types.query_dsl.TermQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: value: description: Term you wish to find in the provided field. allOf: - $ref: '#/components/schemas/_types.FieldValue' case_insensitive: description: 'Allows case insensitive matching of the value with the indexed field values when set to `true`. When `false`, the case sensitivity of matching depends on the underlying field’s mapping.' default: false x-state: Generally available; Added in 7.10.0 type: boolean required: - value indices._types.IndexRoutingAllocationInclude: type: object properties: _tier_preference: type: string _id: allOf: - $ref: '#/components/schemas/_types.Id' _types.analysis.StandardTokenizer: allOf: - $ref: '#/components/schemas/_types.analysis.TokenizerBase' - type: object properties: type: type: string enum: - standard max_token_length: type: number required: - type _types.IndicesResponseBase: allOf: - $ref: '#/components/schemas/_types.AcknowledgedResponseBase' - type: object properties: _shards: allOf: - $ref: '#/components/schemas/_types.ShardStatistics' _types.aggregations.EwmaModelSettings: type: object properties: alpha: type: number _types.mapping.SparseVectorIndexOptions: type: object properties: prune: description: 'Whether to perform pruning, omitting the non-significant tokens from the query to improve query performance. If prune is true but the pruning_config is not specified, pruning will occur but default values will be used. Default: false' x-state: Generally available; Added in 8.19.0 type: boolean pruning_config: description: 'Optional pruning configuration. If enabled, this will omit non-significant tokens from the query in order to improve query performance. This is only used if prune is set to true. If prune is set to true but pruning_config is not specified, default values will be used.' x-state: Generally available; Added in 8.19.0 allOf: - $ref: '#/components/schemas/_types.TokenPruningConfig' indices.shard_stores.ShardStoreException: type: object properties: reason: type: string type: type: string required: - reason - type _types.aggregations.FormatMetricAggregationBase: allOf: - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase' - type: object properties: format: type: string _types.aggregations.ExtendedBoundsFieldDateMath: type: object properties: max: description: Maximum value for the bound. allOf: - $ref: '#/components/schemas/_types.aggregations.FieldDateMath' min: description: Minimum value for the bound. allOf: - $ref: '#/components/schemas/_types.aggregations.FieldDateMath' _types.query_dsl.GeoGridQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: geotile: allOf: - $ref: '#/components/schemas/_types.GeoTile' geohash: allOf: - $ref: '#/components/schemas/_types.GeoHash' geohex: allOf: - $ref: '#/components/schemas/_types.GeoHexCell' minProperties: 1 maxProperties: 1 _types.DistanceUnit: type: string enum: - in - ft - yd - mi - nmi - km - m - cm - mm _types.query_dsl.NumberRangeQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.RangeQueryBasedouble' - type: object _types.aggregations.AverageBucketAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object _types.aggregations.CardinalityExecutionMode: type: string enum: - global_ordinals - segment_ordinals - direct - save_memory_heuristic - save_time_heuristic _types.aggregations.RateMode: type: string enum: - sum - value_count _types.aggregations.CompositeGeoTileGridAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.CompositeAggregationBase' - type: object properties: precision: type: number bounds: allOf: - $ref: '#/components/schemas/_types.GeoBounds' _types.analysis.BengaliNormalizationTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - bengali_normalization required: - type _types.aggregations.DerivativeAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object _types.aggregations.CompositeHistogramAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.CompositeAggregationBase' - type: object properties: interval: type: number required: - interval indices._types.IndexRoutingAllocation: type: object properties: enable: allOf: - $ref: '#/components/schemas/indices._types.IndexRoutingAllocationOptions' include: allOf: - $ref: '#/components/schemas/indices._types.IndexRoutingAllocationInclude' initial_recovery: allOf: - $ref: '#/components/schemas/indices._types.IndexRoutingAllocationInitialRecovery' disk: allOf: - $ref: '#/components/schemas/indices._types.IndexRoutingAllocationDisk' _types.aggregations.HdrMethod: type: object properties: number_of_significant_value_digits: description: Specifies the resolution of values for the histogram in number of significant digits. type: number _types.analysis.CjkWidthTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - cjk_width required: - type _types.VersionNumber: type: number _global.search._types.TrackHits: description: 'Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query. Defaults to 10,000 hits.' oneOf: - type: boolean - type: number _types.query_dsl.FunctionScoreMode: type: string enum: - multiply - sum - avg - first - max - min _types.mapping.AllField: type: object properties: analyzer: type: string enabled: type: boolean omit_norms: type: boolean search_analyzer: type: string similarity: type: string store: type: boolean store_term_vector_offsets: type: boolean store_term_vector_payloads: type: boolean store_term_vector_positions: type: boolean store_term_vectors: type: boolean required: - analyzer - enabled - omit_norms - search_analyzer - similarity - store - store_term_vector_offsets - store_term_vector_payloads - store_term_vector_positions - store_term_vectors indices._types.IndexCheckOnStartup: type: string enum: - 'true' - 'false' - checksum _types.analysis.ReverseTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - reverse required: - type indices.stats.IndexMetadataState: type: string enum: - open - close _types.mapping.NumberPropertyBase: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: boost: type: number coerce: type: boolean ignore_malformed: type: boolean index: type: boolean on_script_error: allOf: - $ref: '#/components/schemas/_types.mapping.OnScriptError' script: allOf: - $ref: '#/components/schemas/_types.Script' time_series_metric: description: For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. x-state: Experimental allOf: - $ref: '#/components/schemas/_types.mapping.TimeSeriesMetricType' time_series_dimension: description: For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. default: false x-state: Experimental type: boolean indices._types.NumericFielddata: type: object properties: format: allOf: - $ref: '#/components/schemas/indices._types.NumericFielddataFormat' required: - format _types.query_dsl.GeoValidationMethod: type: string enum: - coerce - ignore_malformed - strict _types.DFRBasicModel: type: string enum: - be - d - g - if - in - ine - p _types.FielddataStats: type: object properties: evictions: type: number memory_size: allOf: - $ref: '#/components/schemas/_types.ByteSize' memory_size_in_bytes: type: number fields: type: object additionalProperties: $ref: '#/components/schemas/_types.FieldMemoryUsage' global_ordinals: allOf: - $ref: '#/components/schemas/_types.GlobalOrdinalsStats' required: - memory_size_in_bytes - global_ordinals indices.recovery.RecoveryBytes: type: object properties: percent: allOf: - $ref: '#/components/schemas/_types.Percentage' recovered: allOf: - $ref: '#/components/schemas/_types.ByteSize' recovered_in_bytes: allOf: - $ref: '#/components/schemas/_types.ByteSize' recovered_from_snapshot: allOf: - $ref: '#/components/schemas/_types.ByteSize' recovered_from_snapshot_in_bytes: allOf: - $ref: '#/components/schemas/_types.ByteSize' reused: allOf: - $ref: '#/components/schemas/_types.ByteSize' reused_in_bytes: allOf: - $ref: '#/components/schemas/_types.ByteSize' total: allOf: - $ref: '#/components/schemas/_types.ByteSize' total_in_bytes: allOf: - $ref: '#/components/schemas/_types.ByteSize' required: - percent - recovered_in_bytes - reused_in_bytes - total_in_bytes _types.aggregations.BucketCorrelationFunctionCountCorrelation: type: object properties: indicator: description: The indicator with which to correlate the configured `bucket_path` values. allOf: - $ref: '#/components/schemas/_types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator' required: - indicator _types.analysis.IcuAnalyzer: type: object properties: type: type: string enum: - icu_analyzer method: allOf: - $ref: '#/components/schemas/_types.analysis.IcuNormalizationType' mode: allOf: - $ref: '#/components/schemas/_types.analysis.IcuNormalizationMode' required: - type - method - mode indices._types.IndexRoutingAllocationInitialRecovery: type: object properties: _id: allOf: - $ref: '#/components/schemas/_types.Id' _types.query_dsl.LongNumberRangeQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.RangeQueryBaselong' - type: object indices._types.IndexVersioning: type: object properties: created: allOf: - $ref: '#/components/schemas/_types.VersionString' created_string: type: string _types.analysis.ClassicTokenizer: allOf: - $ref: '#/components/schemas/_types.analysis.TokenizerBase' - type: object properties: type: type: string enum: - classic max_token_length: type: number required: - type _types.Duration: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/api-conventions#time-units description: 'A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.' oneOf: - type: string - type: string enum: - '-1' - type: string enum: - '0' _types.mapping.TextIndexPrefixes: type: object properties: max_chars: type: number min_chars: type: number _spec_utils.Stringifiedinteger: description: 'Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type. Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.' oneOf: - type: number - type: string _types.query_dsl.DistanceFeatureQueryBaseDateMathDuration: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: origin: description: 'Date or point of origin used to calculate distances. If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date. Date Math, such as `now-1h`, is supported. If the field value is a `geo_point` field, the `origin` value must be a geopoint.' allOf: - $ref: '#/components/schemas/_types.DateMath' pivot: description: 'Distance from the `origin` at which relevance scores receive half of the `boost` value. If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`.' allOf: - $ref: '#/components/schemas/_types.Duration' field: description: 'Name of the field used to calculate distances. This field must meet the following criteria: be a `date`, `date_nanos` or `geo_point` field; have an `index` mapping parameter value of `true`, which is the default; have an `doc_values` mapping parameter value of `true`, which is the default.' allOf: - $ref: '#/components/schemas/_types.Field' required: - origin - pivot - field indices._types.SettingsSimilarityBm25: type: object properties: type: type: string enum: - BM25 b: type: number discount_overlaps: type: boolean k1: type: number required: - type _types.query_dsl.TermRangeQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.RangeQueryBasestring' - type: object _types.aggregations.DateRangeExpression: type: object properties: from: description: Start of the range (inclusive). allOf: - $ref: '#/components/schemas/_types.aggregations.FieldDateMath' key: description: Custom key to return the range with. type: string to: description: End of the range (exclusive). allOf: - $ref: '#/components/schemas/_types.aggregations.FieldDateMath' _types.aggregations.ValueType: type: string enum: - string - long - double - number - date - date_nanos - ip - numeric - geo_point - boolean indices._types.SettingsAnalyze: type: object properties: max_token_count: default: '10000' allOf: - $ref: '#/components/schemas/_spec_utils.Stringifiedinteger' _global.search._types.Suggester: type: object properties: text: description: Global suggest text, to avoid repetition when the same text is used in several suggesters type: string _types.aggregations.GeoBoundsAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase' - type: object properties: wrap_longitude: description: Specifies whether the bounding box should be allowed to overlap the international date line. default: true type: boolean _types.analysis.SerbianNormalizationTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - serbian_normalization required: - type _types.LinearRetriever: allOf: - $ref: '#/components/schemas/_types.RetrieverBase' - type: object properties: retrievers: description: Inner retrievers. type: array items: $ref: '#/components/schemas/_types.InnerRetriever' rank_window_size: type: number query: type: string fields: type: array items: type: string normalizer: allOf: - $ref: '#/components/schemas/_types.ScoreNormalizer' _types.mapping.UnsignedLongNumberProperty: allOf: - $ref: '#/components/schemas/_types.mapping.NumberPropertyBase' - type: object properties: type: type: string enum: - unsigned_long null_value: allOf: - $ref: '#/components/schemas/_types.ulong' required: - type _types.analysis.CzechStemTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - czech_stem required: - type _types.analysis.LowercaseTokenFilterLanguages: type: string enum: - greek - irish - turkish _types.WaitForActiveShards: oneOf: - type: number - $ref: '#/components/schemas/_types.WaitForActiveShardOptions' indices.stats.ShardCommit: type: object properties: generation: type: number id: allOf: - $ref: '#/components/schemas/_types.Id' num_docs: type: number user_data: type: object additionalProperties: type: string required: - generation - id - num_docs - user_data _types.LookupQueryVectorBuilder: type: object properties: id: description: The ID of the document to fetch the vector from type: string index: description: The name of the index to fetch the document from type: string path: description: The name of the field containing the vector type: string routing: description: The routing value to use when fetching the document type: string required: - id - index - path _types.query_dsl.MatchNoneQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object _types.query_dsl.UntypedDecayFunction: allOf: - $ref: '#/components/schemas/_types.query_dsl.DecayFunctionBase' - type: object _types.aggregations.SimpleMovingAverageAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MovingAverageAggregationBase' - type: object properties: model: type: string enum: - simple settings: allOf: - $ref: '#/components/schemas/_types.EmptyObject' required: - model - settings _types.mapping.OnScriptError: type: string enum: - fail - continue _types.query_dsl.ZeroTermsQuery: type: string enum: - all - none _types.mapping.ScaledFloatNumberProperty: allOf: - $ref: '#/components/schemas/_types.mapping.NumberPropertyBase' - type: object properties: type: type: string enum: - scaled_float null_value: type: number scaling_factor: type: number required: - type _types.uint: type: number _types.analysis.GreekAnalyzer: type: object properties: type: type: string enum: - greek stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string required: - type _types.ShardsOperationResponseBase: type: object properties: _shards: allOf: - $ref: '#/components/schemas/_types.ShardStatistics' indices.get.Features: oneOf: - $ref: '#/components/schemas/indices.get.Feature' - type: array items: $ref: '#/components/schemas/indices.get.Feature' _types.RetrieverBase: type: object properties: filter: description: Query to filter the documents that can match. oneOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' - type: array items: $ref: '#/components/schemas/_types.query_dsl.QueryContainer' min_score: description: Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. type: number _name: description: Retriever name. type: string cluster.stats.DenseVectorOffHeapStats: type: object properties: total_size_bytes: type: number total_size: allOf: - $ref: '#/components/schemas/_types.ByteSize' total_veb_size_bytes: type: number total_veb_size: allOf: - $ref: '#/components/schemas/_types.ByteSize' total_vec_size_bytes: type: number total_vec_size: allOf: - $ref: '#/components/schemas/_types.ByteSize' total_veq_size_bytes: type: number total_veq_size: allOf: - $ref: '#/components/schemas/_types.ByteSize' total_vex_size_bytes: type: number total_vex_size: allOf: - $ref: '#/components/schemas/_types.ByteSize' total_cenivf_size_bytes: type: number total_cenivf_size: allOf: - $ref: '#/components/schemas/_types.ByteSize' total_clivf_size_bytes: type: number total_clivf_size: allOf: - $ref: '#/components/schemas/_types.ByteSize' fielddata: type: object additionalProperties: type: object additionalProperties: type: number required: - total_size_bytes - total_veb_size_bytes - total_vec_size_bytes - total_veq_size_bytes - total_vex_size_bytes - total_cenivf_size_bytes - total_clivf_size_bytes indices.simulate_template.Template: type: object properties: aliases: type: object additionalProperties: $ref: '#/components/schemas/indices._types.Alias' mappings: allOf: - $ref: '#/components/schemas/_types.mapping.TypeMapping' settings: allOf: - $ref: '#/components/schemas/indices._types.IndexSettings' required: - aliases - mappings - settings _spec_utils.NullValue: description: 'A `null` value that is to be interpreted as an actual value, unless other uses of `null` that are equivalent to a missing value. It is used for exemple in settings, where using the `NullValue` for a setting will reset it to its default value.' type: - string - 'null' _types.mapping.TextProperty: allOf: - $ref: '#/components/schemas/_types.mapping.CorePropertyBase' - type: object properties: analyzer: type: string boost: type: number eager_global_ordinals: type: boolean fielddata: type: boolean fielddata_frequency_filter: allOf: - $ref: '#/components/schemas/indices._types.FielddataFrequencyFilter' index: type: boolean index_options: allOf: - $ref: '#/components/schemas/_types.mapping.IndexOptions' index_phrases: type: boolean index_prefixes: oneOf: - $ref: '#/components/schemas/_types.mapping.TextIndexPrefixes' - type: - string - 'null' norms: type: boolean position_increment_gap: type: number search_analyzer: type: string search_quote_analyzer: type: string similarity: oneOf: - type: string - type: - string - 'null' term_vector: allOf: - $ref: '#/components/schemas/_types.mapping.TermVectorOption' type: type: string enum: - text required: - type _types.aggregations.TDigest: type: object properties: compression: description: Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. type: number execution_hint: description: 'The default implementation of TDigest is optimized for performance, scaling to millions or even billions of sample values while maintaining acceptable accuracy levels (close to 1% relative error for millions of samples in some cases). To use an implementation optimized for accuracy, set this parameter to high_accuracy instead.' default: default allOf: - $ref: '#/components/schemas/_types.aggregations.TDigestExecutionHint' _types.analysis.GermanNormalizationTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - german_normalization required: - type _types.VersionType: type: string enum: - internal - external - external_gte _types.analysis.ItalianAnalyzer: type: object properties: type: type: string enum: - italian stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type indices._types.SettingsSimilarityLmd: type: object properties: type: type: string enum: - LMDirichlet mu: type: number required: - type indices.recovery.RecoveryType: type: string enum: - EMPTY_STORE - EXISTING_STORE - LOCAL_SHARDS - PEER - SNAPSHOT indices.analyze.ExplainAnalyzeToken: type: object properties: bytes: type: string end_offset: type: number keyword: type: boolean position: type: number positionLength: type: number start_offset: type: number termFrequency: type: number token: type: string type: type: string required: - bytes - end_offset - position - positionLength - start_offset - termFrequency - token - type _types.aggregations.RareTermsAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: exclude: description: Terms that should be excluded from the aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.TermsExclude' field: description: The field from which to return rare terms. allOf: - $ref: '#/components/schemas/_types.Field' include: description: Terms that should be included in the aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.TermsInclude' max_doc_count: description: The maximum number of documents a term should appear in. default: 1.0 type: number missing: description: 'The value to apply to documents that do not have a value. By default, documents without a value are ignored.' allOf: - $ref: '#/components/schemas/_types.aggregations.Missing' precision: description: 'The precision of the internal CuckooFilters. Smaller precision leads to better approximation, but higher memory usage.' default: 0.001 type: number value_type: type: string _types.aggregations.GeoDistanceAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: distance_type: description: The distance calculation type. default: arc allOf: - $ref: '#/components/schemas/_types.GeoDistanceType' field: description: A field of type `geo_point` used to evaluate the distance. allOf: - $ref: '#/components/schemas/_types.Field' origin: description: The origin used to evaluate the distance. allOf: - $ref: '#/components/schemas/_types.GeoLocation' ranges: description: An array of ranges used to bucket documents. type: array items: $ref: '#/components/schemas/_types.aggregations.AggregationRange' unit: description: The distance unit. default: m allOf: - $ref: '#/components/schemas/_types.DistanceUnit' _types.aggregations.ExtendedBoundsdouble: type: object properties: max: description: Maximum value for the bound. type: number min: description: Minimum value for the bound. type: number _types.StandardRetriever: allOf: - $ref: '#/components/schemas/_types.RetrieverBase' - type: object properties: query: description: Defines a query to retrieve a set of top documents. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' search_after: description: Defines a search after object parameter used for pagination. allOf: - $ref: '#/components/schemas/_types.SortResults' terminate_after: description: Maximum number of documents to collect for each shard. type: number sort: description: A sort object that that specifies the order of matching documents. allOf: - $ref: '#/components/schemas/_types.Sort' collapse: description: Collapses the top documents by a specified key into a single top document per key. allOf: - $ref: '#/components/schemas/_global.search._types.FieldCollapse' _types.aggregations.BucketScriptAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object properties: script: description: The script to run for this aggregation. allOf: - $ref: '#/components/schemas/_types.Script' indices._types.MappingLimitSettings: description: Mapping Limit Settings type: object properties: coerce: type: boolean total_fields: allOf: - $ref: '#/components/schemas/indices._types.MappingLimitSettingsTotalFields' depth: allOf: - $ref: '#/components/schemas/indices._types.MappingLimitSettingsDepth' nested_fields: allOf: - $ref: '#/components/schemas/indices._types.MappingLimitSettingsNestedFields' nested_objects: allOf: - $ref: '#/components/schemas/indices._types.MappingLimitSettingsNestedObjects' field_name_length: allOf: - $ref: '#/components/schemas/indices._types.MappingLimitSettingsFieldNameLength' dimension_fields: allOf: - $ref: '#/components/schemas/indices._types.MappingLimitSettingsDimensionFields' source: allOf: - $ref: '#/components/schemas/indices._types.MappingLimitSettingsSourceFields' ignore_malformed: oneOf: - type: boolean - type: string _types.aggregations.TermsInclude: oneOf: - type: string - type: array items: type: string - $ref: '#/components/schemas/_types.aggregations.TermsPartition' _types.aggregations.LinearMovingAverageAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MovingAverageAggregationBase' - type: object properties: model: type: string enum: - linear settings: allOf: - $ref: '#/components/schemas/_types.EmptyObject' required: - model - settings indices._types.SettingsSimilarity: discriminator: propertyName: type mapping: BM25: '#/components/schemas/indices._types.SettingsSimilarityBm25' DFI: '#/components/schemas/indices._types.SettingsSimilarityDfi' DFR: '#/components/schemas/indices._types.SettingsSimilarityDfr' IB: '#/components/schemas/indices._types.SettingsSimilarityIb' LMDirichlet: '#/components/schemas/indices._types.SettingsSimilarityLmd' LMJelinekMercer: '#/components/schemas/indices._types.SettingsSimilarityLmj' boolean: '#/components/schemas/indices._types.SettingsSimilarityBoolean' scripted: '#/components/schemas/indices._types.SettingsSimilarityScripted' oneOf: - $ref: '#/components/schemas/indices._types.SettingsSimilarityBm25' - $ref: '#/components/schemas/indices._types.SettingsSimilarityBoolean' - $ref: '#/components/schemas/indices._types.SettingsSimilarityDfi' - $ref: '#/components/schemas/indices._types.SettingsSimilarityDfr' - $ref: '#/components/schemas/indices._types.SettingsSimilarityIb' - $ref: '#/components/schemas/indices._types.SettingsSimilarityLmd' - $ref: '#/components/schemas/indices._types.SettingsSimilarityLmj' - $ref: '#/components/schemas/indices._types.SettingsSimilarityScripted' _types.aggregations.ValueCountAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.FormattableMetricAggregation' - type: object indices.stats.ShardSequenceNumber: type: object properties: global_checkpoint: type: number local_checkpoint: type: number max_seq_no: allOf: - $ref: '#/components/schemas/_types.SequenceNumber' required: - global_checkpoint - local_checkpoint - max_seq_no _types.analysis.EdgeNGramSide: type: string enum: - front - back _types.query_dsl.HasChildQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: ignore_unmapped: description: Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. default: false type: boolean inner_hits: externalDocs: url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-inner-hits description: If defined, each search hit will contain inner hits. allOf: - $ref: '#/components/schemas/_global.search._types.InnerHits' max_children: description: 'Maximum number of child documents that match the query allowed for a returned parent document. If the parent document exceeds this limit, it is excluded from the search results.' type: number min_children: description: 'Minimum number of child documents that match the query required to match the query for a returned parent document. If the parent document does not meet this limit, it is excluded from the search results.' type: number query: description: 'Query you wish to run on child documents of the `type` field. If a child document matches the search, the query returns the parent document.' allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' score_mode: description: Indicates how scores for matching child documents affect the root parent document’s relevance score. default: '''none''' allOf: - $ref: '#/components/schemas/_types.query_dsl.ChildScoreMode' type: description: Name of the child relationship mapped for the `join` field. allOf: - $ref: '#/components/schemas/_types.RelationName' required: - query - type _types.analysis.ScandinavianFoldingTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - scandinavian_folding required: - type _types.query_dsl.DateDistanceFeatureQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.DistanceFeatureQueryBaseDateMathDuration' - type: object indices._types.SettingsSearch: type: object properties: idle: allOf: - $ref: '#/components/schemas/indices._types.SearchIdle' slowlog: allOf: - $ref: '#/components/schemas/indices._types.SlowlogSettings' indices.recovery.RecoveryPriority: type: string enum: - UNASSIGNED_NEW_PRIMARY - UNASSIGNED_UNEXPECTED - UNASSIGNED_EXPECTED - RELOCATION_CAN_REMAIN_NO - RELOCATION_CAN_REMAIN_NOT_PREFERRED - RELOCATE_REBALANCING - UNKNOWN _types.aggregations.GlobalAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object _types.mapping.DenseVectorIndexOptionsRescoreVector: type: object properties: oversample: description: 'The oversampling factor to use when searching for the nearest neighbor. This is only applicable to the quantized formats: `bbq_*`, `int4_*`, and `int8_*`. When provided, `oversample * k` vectors will be gathered and then their scores will be re-computed with the original vectors. valid values are between `1.0` and `10.0` (inclusive), or `0` exactly to disable oversampling.' type: number required: - oversample _types.aggregations.Aggregation: type: object _types.analysis.StandardAnalyzer: type: object properties: type: type: string enum: - standard max_token_length: description: 'The maximum token length. If a token is seen that exceeds this length then it is split at `max_token_length` intervals. Defaults to `255`.' default: 255.0 type: number stopwords: description: 'A pre-defined stop words list like `_english_` or an array containing a list of stop words. Defaults to `_none_`.' default: _none_ allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: description: The path to a file containing stop words. type: string required: - type _types.analysis.LowercaseTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - lowercase language: description: Language-specific lowercase token filter to use. allOf: - $ref: '#/components/schemas/_types.analysis.LowercaseTokenFilterLanguages' required: - type _types.aggregations.TimeSeriesAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: size: description: The maximum number of results to return. default: 10000.0 type: number keyed: description: Set to `true` to associate a unique string key with each bucket and returns the ranges as a hash rather than an array. type: boolean _types.query_dsl.SpanOrQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: clauses: description: Array of one or more other span type queries. type: array items: $ref: '#/components/schemas/_types.query_dsl.SpanQuery' required: - clauses _types.query_dsl.BoolQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: filter: description: 'The clause (query) must appear in matching documents. However, unlike `must`, the score of the query will be ignored.' oneOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' - type: array items: $ref: '#/components/schemas/_types.query_dsl.QueryContainer' minimum_should_match: description: Specifies the number or percentage of `should` clauses returned documents must match. allOf: - $ref: '#/components/schemas/_types.MinimumShouldMatch' must: description: The clause (query) must appear in matching documents and will contribute to the score. oneOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' - type: array items: $ref: '#/components/schemas/_types.query_dsl.QueryContainer' must_not: description: 'The clause (query) must not appear in the matching documents. Because scoring is ignored, a score of `0` is returned for all documents.' oneOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' - type: array items: $ref: '#/components/schemas/_types.query_dsl.QueryContainer' should: description: The clause (query) should appear in the matching document. oneOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' - type: array items: $ref: '#/components/schemas/_types.query_dsl.QueryContainer' _types.SpecifiedDocument: type: object properties: index: allOf: - $ref: '#/components/schemas/_types.IndexName' id: allOf: - $ref: '#/components/schemas/_types.Id' required: - id _types.query_dsl.SimpleQueryStringQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: analyzer: description: Analyzer used to convert text in the query string into tokens. type: string analyze_wildcard: description: If `true`, the query attempts to analyze wildcard terms in the query string. default: false type: boolean auto_generate_synonyms_phrase_query: description: If `true`, the parser creates a match_phrase query for each multi-position token. default: true type: boolean default_operator: description: Default boolean logic used to interpret text in the query string if no operators are specified. default: '''or''' allOf: - $ref: '#/components/schemas/_types.query_dsl.Operator' fields: description: 'Array of fields you wish to search. Accepts wildcard expressions. You also can boost relevance scores for matches to particular fields using a caret (`^`) notation. Defaults to the `index.query.default_field index` setting, which has a default value of `*`.' type: array items: $ref: '#/components/schemas/_types.Field' flags: description: List of enabled operators for the simple query string syntax. default: ALL allOf: - $ref: '#/components/schemas/_types.query_dsl.SimpleQueryStringFlags' fuzzy_max_expansions: description: Maximum number of terms to which the query expands for fuzzy matching. default: 50.0 type: number fuzzy_prefix_length: description: Number of beginning characters left unchanged for fuzzy matching. default: 0.0 type: number fuzzy_transpositions: description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). type: boolean lenient: description: If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. default: false type: boolean minimum_should_match: description: Minimum number of clauses that must match for a document to be returned. allOf: - $ref: '#/components/schemas/_types.MinimumShouldMatch' query: description: Query string in the simple query string syntax you wish to parse and use for search. type: string quote_field_suffix: description: Suffix appended to quoted text in the query string. type: string required: - query indices.recovery.VerifyIndex: type: object properties: check_index_time: allOf: - $ref: '#/components/schemas/_types.Duration' check_index_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' total_time: allOf: - $ref: '#/components/schemas/_types.Duration' total_time_in_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' required: - check_index_time_in_millis - total_time_in_millis indices._types.IndexingPressureMemory: type: object properties: limit: description: 'Number of outstanding bytes that may be consumed by indexing requests. When this limit is reached or exceeded, the node will reject new coordinating and primary operations. When replica operations consume 1.5x this limit, the node will reject new replica operations. Defaults to 10% of the heap.' type: number indices.stats.ShardQueryCache: type: object properties: cache_count: type: number cache_size: type: number evictions: type: number hit_count: type: number memory_size: allOf: - $ref: '#/components/schemas/_types.ByteSize' memory_size_in_bytes: type: number miss_count: type: number total_count: type: number required: - cache_count - cache_size - evictions - hit_count - memory_size_in_bytes - miss_count - total_count _types.aggregations.InferenceConfigContainer: type: object properties: regression: description: Regression configuration for inference. allOf: - $ref: '#/components/schemas/ml._types.RegressionInferenceOptions' classification: description: Classification configuration for inference. allOf: - $ref: '#/components/schemas/ml._types.ClassificationInferenceOptions' minProperties: 1 maxProperties: 1 _types.SortCombinations: oneOf: - $ref: '#/components/schemas/_types.Field' - $ref: '#/components/schemas/_types.SortOptions' _types.aggregations.GapPolicy: type: string enum: - skip - insert_zeros - keep_values indices.update_aliases.RemoveAction: type: object properties: alias: description: 'Alias for the action. Index alias names support date math.' allOf: - $ref: '#/components/schemas/_types.IndexAlias' aliases: description: 'Aliases for the action. Index alias names support date math.' oneOf: - $ref: '#/components/schemas/_types.IndexAlias' - type: array items: $ref: '#/components/schemas/_types.IndexAlias' index: description: 'Data stream or index for the action. Supports wildcards (`*`).' allOf: - $ref: '#/components/schemas/_types.IndexName' indices: description: 'Data streams or indices for the action. Supports wildcards (`*`).' allOf: - $ref: '#/components/schemas/_types.Indices' must_exist: description: If `true`, the alias must exist to perform the action. default: false type: boolean _types.analysis.FlattenGraphTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - flatten_graph required: - type _types.analysis.LengthTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - length max: description: Maximum character length of a token. Longer tokens are excluded from the output. Defaults to `Integer.MAX_VALUE`, which is `2^31-1` or `2147483647`. type: number min: description: Minimum character length of a token. Shorter tokens are excluded from the output. Defaults to `0`. type: number required: - type _types.CommonStatsFlags: oneOf: - $ref: '#/components/schemas/_types.CommonStatsFlag' - type: array items: $ref: '#/components/schemas/_types.CommonStatsFlag' _types.analysis.PatternReplaceTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - pattern_replace all: description: If `true`, all substrings matching the pattern parameter’s regular expression are replaced. If `false`, the filter replaces only the first matching substring in each token. Defaults to `true`. type: boolean flags: type: string pattern: description: Regular expression, written in Java’s regular expression syntax. The filter replaces token substrings matching this pattern with the substring in the `replacement` parameter. type: string replacement: description: Replacement substring. Defaults to an empty substring (`""`). type: string required: - type - pattern _types.query_dsl.RangeQueryBasestring: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: relation: description: Indicates how the range query matches values for `range` fields. default: intersects allOf: - $ref: '#/components/schemas/_types.query_dsl.RangeRelation' gt: description: Greater than. type: string gte: description: Greater than or equal to. type: string lt: description: Less than. type: string lte: description: Less than or equal to. type: string _types.query_dsl.ScriptScoreFunction: type: object properties: script: description: A script that computes a score. allOf: - $ref: '#/components/schemas/_types.Script' required: - script _types.aggregations.DiversifiedSamplerAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: execution_hint: description: The type of value used for de-duplication. default: global_ordinals allOf: - $ref: '#/components/schemas/_types.aggregations.SamplerAggregationExecutionHint' max_docs_per_value: description: Limits how many documents are permitted per choice of de-duplicating value. default: 1.0 type: number script: allOf: - $ref: '#/components/schemas/_types.Script' shard_size: description: Limits how many top-scoring documents are collected in the sample processed on each shard. default: 100.0 type: number field: description: The field used to provide values used for de-duplication. allOf: - $ref: '#/components/schemas/_types.Field' _types.aggregations.NestedAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: path: description: The path to the field of type `nested`. allOf: - $ref: '#/components/schemas/_types.Field' _types.analysis.CjkBigramIgnoredScript: type: string enum: - han - hangul - hiragana - katakana indices._types.IndexSegmentSort: type: object properties: field: allOf: - $ref: '#/components/schemas/_types.Fields' order: oneOf: - $ref: '#/components/schemas/indices._types.SegmentSortOrder' - type: array items: $ref: '#/components/schemas/indices._types.SegmentSortOrder' mode: oneOf: - $ref: '#/components/schemas/indices._types.SegmentSortMode' - type: array items: $ref: '#/components/schemas/indices._types.SegmentSortMode' missing: oneOf: - $ref: '#/components/schemas/indices._types.SegmentSortMissing' - type: array items: $ref: '#/components/schemas/indices._types.SegmentSortMissing' _types.aggregations.CalendarInterval: type: string enum: - second - 1s - minute - 1m - hour - 1h - day - 1d - week - 1w - month - 1M - quarter - 1q - year - 1y indices.resolve_cluster.ResolveClusterInfo: description: Provides information about each cluster request relevant to doing a cross-cluster search. type: object properties: connected: description: Whether the remote cluster is connected to the local (querying) cluster. type: boolean skip_unavailable: description: The `skip_unavailable` setting for a remote cluster. type: boolean matching_indices: description: 'Whether the index expression provided in the request matches any indices, aliases or data streams on the cluster.' type: boolean error: description: 'Provides error messages that are likely to occur if you do a search with this index expression on the specified cluster (for example, lack of security privileges to query an index).' type: string version: description: Provides version information about the cluster. allOf: - $ref: '#/components/schemas/_types.ElasticsearchVersionMinInfo' required: - connected - skip_unavailable _types.mapping.FieldNamesField: type: object properties: enabled: type: boolean required: - enabled _types.ScriptSource: oneOf: - type: string - $ref: '#/components/schemas/_global.search._types.SearchRequestBody' indices._types.IndexTemplate: type: object properties: index_patterns: description: Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation. allOf: - $ref: '#/components/schemas/_types.Names' composed_of: description: 'An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.' type: array items: $ref: '#/components/schemas/_types.Name' template: description: 'Template to be applied. It may optionally include an `aliases`, `mappings`, or `settings` configuration.' allOf: - $ref: '#/components/schemas/indices._types.IndexTemplateSummary' version: description: 'Version number used to manage index templates externally. This number is not automatically generated by Elasticsearch.' allOf: - $ref: '#/components/schemas/_types.VersionNumber' priority: description: 'Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by Elasticsearch.' type: number _meta: description: 'Optional user metadata about the index template. May have any contents. This map is not automatically generated by Elasticsearch.' allOf: - $ref: '#/components/schemas/_types.Metadata' allow_auto_create: type: boolean data_stream: description: 'If this object is included, the template is used to create data streams and their backing indices. Supports an empty object. Data streams require a matching index template with a `data_stream` object.' allOf: - $ref: '#/components/schemas/indices._types.IndexTemplateDataStreamConfiguration' deprecated: description: 'Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning.' x-state: Generally available; Added in 8.12.0 type: boolean ignore_missing_component_templates: description: A list of component template names that are allowed to be absent. x-state: Generally available; Added in 8.7.0 allOf: - $ref: '#/components/schemas/_types.Names' created_date: description: Date and time when the index template was created. Only returned if the `human` query parameter is `true`. x-state: Generally available; Added in 9.2.0 allOf: - $ref: '#/components/schemas/_types.DateTime' created_date_millis: description: Date and time when the index template was created, in milliseconds since the epoch. x-state: Generally available; Added in 9.2.0 allOf: - $ref: '#/components/schemas/_types.EpochTimeUnitMillis' modified_date: description: Date and time when the index template was last modified. Only returned if the `human` query parameter is `true`. x-state: Generally available; Added in 9.2.0 allOf: - $ref: '#/components/schemas/_types.DateTime' modified_date_millis: description: Date and time when the index template was last modified, in milliseconds since the epoch. x-state: Generally available; Added in 9.2.0 allOf: - $ref: '#/components/schemas/_types.EpochTimeUnitMillis' required: - index_patterns - composed_of cluster.stats.SparseVectorStats: type: object properties: value_count: type: number required: - value_count _types.analysis.KeepWordsTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - keep keep_words: description: 'List of words to keep. Only tokens that match words in this list are included in the output. Either this parameter or `keep_words_path` must be specified.' type: array items: type: string keep_words_case: description: If `true`, lowercase all keep words. Defaults to `false`. type: boolean keep_words_path: description: 'Path to a file that contains a list of words to keep. Only tokens that match words in this list are included in the output. This path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each word in the file must be separated by a line break. Either this parameter or `keep_words` must be specified.' type: string required: - type _types.analysis.NorwegianAnalyzer: type: object properties: type: type: string enum: - norwegian stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type _types.mapping.DoubleRangeProperty: allOf: - $ref: '#/components/schemas/_types.mapping.RangePropertyBase' - type: object properties: type: type: string enum: - double_range required: - type _types.mapping.SourceFieldMode: type: string enum: - disabled - stored - synthetic indices.rollover.RolloverConditions: type: object properties: min_age: allOf: - $ref: '#/components/schemas/_types.Duration' max_age: allOf: - $ref: '#/components/schemas/_types.Duration' max_age_millis: allOf: - $ref: '#/components/schemas/_types.DurationValueUnitMillis' min_docs: type: number max_docs: type: number max_size: deprecated: true description: The `max_size` condition has been deprecated in 9.3.0 and `max_primary_shard_size` should be used instead allOf: - $ref: '#/components/schemas/_types.ByteSize' max_size_bytes: type: number min_size: allOf: - $ref: '#/components/schemas/_types.ByteSize' min_size_bytes: type: number max_primary_shard_size: allOf: - $ref: '#/components/schemas/_types.ByteSize' max_primary_shard_size_bytes: type: number min_primary_shard_size: allOf: - $ref: '#/components/schemas/_types.ByteSize' min_primary_shard_size_bytes: type: number max_primary_shard_docs: type: number min_primary_shard_docs: type: number _types.aggregations.CompositeAggregateKey: type: object additionalProperties: $ref: '#/components/schemas/_types.FieldValue' _types.mapping.GeoPointProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: ignore_malformed: type: boolean ignore_z_value: type: boolean null_value: allOf: - $ref: '#/components/schemas/_types.GeoLocation' index: type: boolean on_script_error: allOf: - $ref: '#/components/schemas/_types.mapping.OnScriptError' script: allOf: - $ref: '#/components/schemas/_types.Script' type: type: string enum: - geo_point time_series_metric: allOf: - $ref: '#/components/schemas/_types.mapping.GeoPointMetricType' required: - type _types.Normalization: type: string enum: - 'no' - h1 - h2 - h3 - z _types.analysis.RemoveDuplicatesTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - remove_duplicates required: - type _types.query_dsl.MatchQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: analyzer: description: Analyzer used to convert the text in the query value into tokens. type: string auto_generate_synonyms_phrase_query: description: If `true`, match phrase queries are automatically created for multi-term synonyms. default: true type: boolean cutoff_frequency: deprecated: true type: number fuzziness: description: Maximum edit distance allowed for matching. allOf: - $ref: '#/components/schemas/_types.Fuzziness' fuzzy_rewrite: description: Method used to rewrite the query. allOf: - $ref: '#/components/schemas/_types.MultiTermQueryRewrite' fuzzy_transpositions: description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). default: true type: boolean lenient: description: If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. default: false type: boolean max_expansions: description: Maximum number of terms to which the query will expand. default: 50.0 type: number minimum_should_match: description: Minimum number of clauses that must match for a document to be returned. allOf: - $ref: '#/components/schemas/_types.MinimumShouldMatch' operator: description: Boolean logic used to interpret text in the query value. default: '''or''' allOf: - $ref: '#/components/schemas/_types.query_dsl.Operator' prefix_length: description: Number of beginning characters left unchanged for fuzzy matching. default: 0.0 type: number query: description: Text, number, boolean value or date you wish to find in the provided field. oneOf: - type: string - type: number - type: boolean zero_terms_query: description: Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. default: '''none''' allOf: - $ref: '#/components/schemas/_types.query_dsl.ZeroTermsQuery' required: - query _types.aggregations.CumulativeCardinalityAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object _types.mapping.RankFeaturesProperty: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: positive_score_impact: type: boolean type: type: string enum: - rank_features required: - type _types.analysis.EdgeNGramTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - edge_ngram max_gram: description: Maximum character length of a gram. For custom token filters, defaults to `2`. For the built-in edge_ngram filter, defaults to `1`. type: number min_gram: description: Minimum character length of a gram. Defaults to `1`. type: number side: description: Indicates whether to truncate tokens from the `front` or `back`. Defaults to `front`. allOf: - $ref: '#/components/schemas/_types.analysis.EdgeNGramSide' preserve_original: description: Emits original token when set to `true`. Defaults to `false`. allOf: - $ref: '#/components/schemas/_spec_utils.Stringifiedboolean' required: - type indices._types.SettingsSimilarityDfi: type: object properties: type: type: string enum: - DFI independence_measure: allOf: - $ref: '#/components/schemas/_types.DFIIndependenceMeasure' required: - type - independence_measure _types.DFRAfterEffect: type: string enum: - 'no' - b - l _types.query_dsl.SimpleQueryStringFlag: type: string enum: - NONE - AND - NOT - OR - PREFIX - PHRASE - PRECEDENCE - ESCAPE - WHITESPACE - FUZZY - NEAR - SLOP - ALL _types.query_dsl.WeightedTokensQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: tokens: description: The tokens representing this query oneOf: - type: object additionalProperties: type: number - type: array items: type: object additionalProperties: type: number pruning_config: description: Token pruning configurations allOf: - $ref: '#/components/schemas/_types.TokenPruningConfig' required: - tokens _types.mapping.ByteNumberProperty: allOf: - $ref: '#/components/schemas/_types.mapping.NumberPropertyBase' - type: object properties: type: type: string enum: - byte null_value: allOf: - $ref: '#/components/schemas/_types.byte' required: - type _types.Routing: description: Only to be used in query and path parameters, as the array form is actually a csv oneOf: - type: string - type: array items: type: string _types.aggregations.BucketsPath: description: 'Buckets path can be expressed in different ways, and an aggregation may accept some or all of these forms depending on its type. Please refer to each aggregation''s documentation to know what buckets path forms they accept.' oneOf: - type: string - type: array items: type: string - type: object additionalProperties: type: string _types.aggregations.MinBucketAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object _types.mapping.ExponentialHistogramProperty: allOf: - $ref: '#/components/schemas/_types.mapping.PropertyBase' - type: object properties: time_series_metric: allOf: - $ref: '#/components/schemas/_types.mapping.TimeSeriesMetricType' type: type: string enum: - exponential_histogram required: - type _types.analysis.RussianAnalyzer: type: object properties: type: type: string enum: - russian stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type indices._types.MappingLimitSettingsNestedObjects: type: object properties: limit: description: 'The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects.' default: 10000.0 type: number indices.analyze.CharFilterDetail: type: object properties: filtered_text: type: array items: type: string name: type: string required: - filtered_text - name _types.aggregations.GeoCentroidAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase' - type: object properties: count: type: number location: allOf: - $ref: '#/components/schemas/_types.GeoLocation' _types.mapping.HalfFloatNumberProperty: allOf: - $ref: '#/components/schemas/_types.mapping.NumberPropertyBase' - type: object properties: type: type: string enum: - half_float null_value: type: number required: - type _types.query_dsl.IntervalsRange: type: object properties: analyzer: description: Analyzer used to analyze the `prefix`. type: string gte: description: Lower term, either gte or gt must be provided. type: string gt: description: Lower term, either gte or gt must be provided. type: string lte: description: Upper term, either lte or lt must be provided. type: string lt: description: Upper term, either lte or lt must be provided. type: string use_field: description: 'If specified, match intervals from this field rather than the top-level field. The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.' allOf: - $ref: '#/components/schemas/_types.Field' _types.analysis.PathHierarchyTokenizer: allOf: - $ref: '#/components/schemas/_types.analysis.TokenizerBase' - type: object properties: type: type: string enum: - path_hierarchy buffer_size: allOf: - $ref: '#/components/schemas/_spec_utils.Stringifiedinteger' delimiter: type: string replacement: type: string reverse: allOf: - $ref: '#/components/schemas/_spec_utils.Stringifiedboolean' skip: allOf: - $ref: '#/components/schemas/_spec_utils.Stringifiedinteger' required: - type _global.search._types.ScriptRescore: type: object properties: script: allOf: - $ref: '#/components/schemas/_types.Script' required: - script _types.mapping.KeywordProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: boost: type: number eager_global_ordinals: type: boolean index: type: boolean index_options: allOf: - $ref: '#/components/schemas/_types.mapping.IndexOptions' script: allOf: - $ref: '#/components/schemas/_types.Script' on_script_error: allOf: - $ref: '#/components/schemas/_types.mapping.OnScriptError' normalizer: type: string norms: type: boolean null_value: type: string similarity: oneOf: - type: string - type: - string - 'null' split_queries_on_whitespace: type: boolean time_series_dimension: description: For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. x-state: Experimental type: boolean type: type: string enum: - keyword required: - type _types.analysis.ChineseAnalyzer: type: object properties: type: type: string enum: - chinese stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string required: - type _types.query_dsl.RankFeatureFunctionLogarithm: allOf: - $ref: '#/components/schemas/_types.query_dsl.RankFeatureFunction' - type: object properties: scaling_factor: description: Configurable scaling factor. type: number required: - scaling_factor _types.query_dsl.GeoDistanceQuery: allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryBase' - type: object properties: distance: description: 'The radius of the circle centred on the specified location. Points which fall into this circle are considered to be matches.' allOf: - $ref: '#/components/schemas/_types.Distance' distance_type: description: 'How to compute the distance. Set to `plane` for a faster calculation that''s inaccurate on long distances and close to the poles.' default: '''arc''' allOf: - $ref: '#/components/schemas/_types.GeoDistanceType' validation_method: description: 'Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude. Set to `COERCE` to also try to infer correct latitude or longitude.' default: '''strict''' allOf: - $ref: '#/components/schemas/_types.query_dsl.GeoValidationMethod' ignore_unmapped: description: 'Set to `true` to ignore an unmapped field and not match any documents for this query. Set to `false` to throw an exception if the field is not mapped.' default: false type: boolean required: - distance _types.analysis.SerbianAnalyzer: type: object properties: type: type: string enum: - serbian stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type _types.query_dsl.GeoDecayFunction: allOf: - $ref: '#/components/schemas/_types.query_dsl.DecayFunctionBaseGeoLocationDistance' - type: object _types.aggregations.BucketCorrelationFunction: type: object properties: count_correlation: description: The configuration to calculate a count correlation. This function is designed for determining the correlation of a term value and a given metric. allOf: - $ref: '#/components/schemas/_types.aggregations.BucketCorrelationFunctionCountCorrelation' required: - count_correlation _types.analysis.PorterStemTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - porter_stem required: - type _types.analysis.IcuTransformTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - icu_transform dir: allOf: - $ref: '#/components/schemas/_types.analysis.IcuTransformDirection' id: type: string required: - type - id _types.analysis.PhoneticTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - phonetic encoder: allOf: - $ref: '#/components/schemas/_types.analysis.PhoneticEncoder' languageset: oneOf: - $ref: '#/components/schemas/_types.analysis.PhoneticLanguage' - type: array items: $ref: '#/components/schemas/_types.analysis.PhoneticLanguage' max_code_len: type: number name_type: allOf: - $ref: '#/components/schemas/_types.analysis.PhoneticNameType' replace: type: boolean rule_type: allOf: - $ref: '#/components/schemas/_types.analysis.PhoneticRuleType' required: - type - encoder indices.validate_query.IndicesValidationExplanation: type: object properties: error: type: string explanation: type: string index: allOf: - $ref: '#/components/schemas/_types.IndexName' shard: type: number valid: type: boolean required: - valid _types.query_dsl.IntervalsMatch: type: object properties: analyzer: description: Analyzer used to analyze terms in the query. type: string max_gaps: description: 'Maximum number of positions between the matching terms. Terms further apart than this are not considered matches.' default: -1.0 type: number ordered: description: If `true`, matching terms must appear in their specified order. default: false type: boolean query: description: Text you wish to find in the provided field. type: string use_field: description: 'If specified, match intervals from this field rather than the top-level field. The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.' allOf: - $ref: '#/components/schemas/_types.Field' filter: description: An optional interval filter. allOf: - $ref: '#/components/schemas/_types.query_dsl.IntervalsFilter' required: - query _types.mapping.RoutingField: type: object properties: required: type: boolean required: - required _types.IBLambda: type: string enum: - df - ttf _types.aggregations.PercentilesBucketAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase' - type: object properties: percents: description: The list of percentiles to calculate. type: array items: type: number _types.ChunkRescorer: type: object properties: size: description: The number of chunks per document to evaluate for reranking. type: number chunking_settings: description: Chunking settings to apply allOf: - $ref: '#/components/schemas/_types.mapping.ChunkRescorerChunkingSettings' _types.mapping.DateRangeProperty: allOf: - $ref: '#/components/schemas/_types.mapping.RangePropertyBase' - type: object properties: format: type: string type: type: string enum: - date_range required: - type _types.analysis.SoraniAnalyzer: type: object properties: type: type: string enum: - sorani stopwords: allOf: - $ref: '#/components/schemas/_types.analysis.StopWords' stopwords_path: type: string stem_exclusion: type: array items: type: string required: - type inference._types.EmbeddingContentType: type: string enum: - text - image - audio - video - pdf _types.aggregations.IpRangeAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase' - type: object properties: field: description: The date field whose values are used to build ranges. allOf: - $ref: '#/components/schemas/_types.Field' ranges: description: Array of IP ranges. type: array items: $ref: '#/components/schemas/_types.aggregations.IpRangeAggregationRange' _types.analysis.KStemTokenFilter: allOf: - $ref: '#/components/schemas/_types.analysis.TokenFilterBase' - type: object properties: type: type: string enum: - kstem required: - type _types.mapping.BooleanProperty: allOf: - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase' - type: object properties: boost: type: number fielddata: allOf: - $ref: '#/components/schemas/indices._types.NumericFielddata' index: type: boolean null_value: type: boolean ignore_malformed: type: boolean script: allOf: - $ref: '#/components/schemas/_types.Script' on_script_error: allOf: - $ref: '#/components/schemas/_types.mapping.OnScriptError' time_series_dimension: description: For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. x-state: Experimental type: boolean type: type: string enum: - boolean required: - type _types.aggregations.AggregateOrder: oneOf: - type: object additionalProperties: $ref: '#/components/schemas/_types.SortOrder' minProperties: 1 maxProperties: 1 - type: array items: type: object additionalProperties: $ref: '#/components/schemas/_types.SortOrder' minProperties: 1 maxProperties: 1 _types.aggregations.MinAggregation: allOf: - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase' - type: object _types.aggregations.CompositeAggregationSource: type: object properties: terms: description: A terms aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.CompositeTermsAggregation' histogram: description: A histogram aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.CompositeHistogramAggregation' date_histogram: description: A date histogram aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.CompositeDateHistogramAggregation' geotile_grid: description: A geotile grid aggregation. allOf: - $ref: '#/components/schemas/_types.aggregations.CompositeGeoTileGridAggregation' minProperties: 1 maxProperties: 1 _types.ErrorCause: description: 'Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.' type: object properties: type: description: The type of error type: string reason: description: A human-readable explanation of the error, in English. oneOf: - type: string - type: - string - 'null' stack_trace: description: The server stack trace. Present only if the `error_trace=true` parameter was sent with the request. type: string caused_by: allOf: - $ref: '#/components/schemas/_types.ErrorCause' root_cause: type: array items: $ref: '#/components/schemas/_types.ErrorCause' suppressed: type: array items: $ref: '#/components/schemas/_types.ErrorCause' required: - type _types.aggregations.HoltLinearModelSettings: type: object properties: alpha: type: number beta: type: number indices._types.MappingLimitSettingsNestedFields: type: object properties: limit: description: 'The maximum number of distinct nested mappings in an index. The nested type should only be used in special cases, when arrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this setting limits the number of unique nested types per index.' default: 50.0 type: number indices.get_field_mapping.TypeFieldMappings: type: object properties: mappings: type: object additionalProperties: $ref: '#/components/schemas/_types.mapping.FieldMapping' required: - mappings _types.UnitMillis: description: Time unit for milliseconds type: number responses: indices.shard_stores-200: description: '' content: application/json: schema: type: object properties: indices: type: object additionalProperties: $ref: '#/components/schemas/indices.shard_stores.IndicesShardStores' required: - indices examples: indicesShardStoresResponseExample1: description: 'An abbreviated response from `GET /_shard_stores?status=green`. ' value: "{\n \"indices\": {\n \"my-index-000001\": {\n \"shards\": {\n \"0\": {\n \"stores\": [\n {\n \"sPa3OgxLSYGvQ4oPs-Tajw\": {\n \"name\": \"node_t0\",\n \"ephemeral_id\": \"9NlXRFGCT1m8tkvYCMK-8A\",\n \"transport_address\": \"local[1]\",\n \"external_id\": \"node_t0\",\n \"attributes\": {},\n \"roles\": [],\n \"version\": \"8.10.0\",\n \"min_index_version\": 7000099,\n \"max_index_version\": 8100099\n },\n \"allocation_id\": \"2iNySv_OQVePRX-yaRH_lQ\",\n \"allocation\": \"primary\",\n \"store_exception\": {}\n }\n ]\n }\n }\n }\n }\n}" indices.resolve_index-200: description: '' content: application/json: schema: type: object properties: indices: type: array items: $ref: '#/components/schemas/indices.resolve_index.ResolveIndexItem' aliases: type: array items: $ref: '#/components/schemas/indices.resolve_index.ResolveIndexAliasItem' data_streams: type: array items: $ref: '#/components/schemas/indices.resolve_index.ResolveIndexDataStreamsItem' required: - indices - aliases - data_streams examples: ResolveIndexResponseExample1: description: A successful response from `GET /_resolve/index/f*,remoteCluster1:bar*?expand_wildcards=all`. value: "{\n \"indices\": [\n {\n \"name\": \"foo_closed\",\n \"attributes\": [\n \"closed\"\n ],\n \"mode\": \"standard\"\n },\n {\n \"name\": \"freeze-index\",\n \"aliases\": [\n \"f-alias\"\n ],\n \"attributes\": [\n \"open\"\n ]\n },\n {\n \"name\": \"remoteCluster1:bar-01\",\n \"attributes\": [\n \"open\"\n ]\n }\n ],\n \"aliases\": [\n {\n \"name\": \"f-alias\",\n \"indices\": [\n \"freeze-index\",\n \"my-index-000001\"\n ]\n }\n ],\n \"data_streams\": [\n {\n \"name\": \"foo\",\n \"backing_indices\": [\n \".ds-foo-2099.03.07-000001\"\n ],\n \"timestamp_field\": \"@timestamp\"\n }\n ]\n}" cluster.get_component_template-200: description: '' content: application/json: schema: type: object properties: component_templates: type: array items: $ref: '#/components/schemas/cluster._types.ComponentTemplate' required: - component_templates examples: GetComponentTemplateResponseExample1: description: A successful response for retrieving information about a component template. value: "{\n \"component_templates\" : [\n {\n \"name\" : \"my-component-template\",\n \"component_template\" : {\n \"version\" : 1,\n \"_meta\" : {\n \"description\" : \"my custom component template\"\n },\n \"template\" : {\n \"settings\" : {\n \"index\" : {\n \"number_of_shards\" : \"1\"\n }\n },\n \"mappings\" : {\n \"properties\" : {\n \"@timestamp\" : {\n \"type\" : \"date\"\n },\n \"message\" : {\n \"type\" : \"text\"\n }\n }\n }\n },\n \"created_date\" : \"2024-01-01T12:00:00.000Z\",\n \"created_date_millis\" : 1704110400000,\n \"modified_date\" : \"2025-01-01T12:00:00.000Z\",\n \"modified_date_millis\" : 1735732800000\n }\n }\n ]\n}" indices.clear_cache-200: description: '' content: application/json: schema: $ref: '#/components/schemas/_types.ShardsOperationResponseBase' cluster.put_component_template-200: description: '' content: application/json: schema: $ref: '#/components/schemas/_types.AcknowledgedResponseBase' indices.rollover-200: description: '' content: application/json: schema: type: object properties: acknowledged: type: boolean conditions: type: object additionalProperties: type: boolean dry_run: type: boolean new_index: type: string old_index: type: string rolled_over: type: boolean shards_acknowledged: type: boolean required: - acknowledged - conditions - dry_run - new_index - old_index - rolled_over - shards_acknowledged examples: indicesRolloverResponseExample1: description: 'An abbreviated response from `GET /_segments`. ' value: "{\n \"_shards\": {},\n \"indices\": {\n \"test\": {\n \"shards\": {\n \"0\": [\n {\n \"routing\": {\n \"state\": \"STARTED\",\n \"primary\": true,\n \"node\": \"zDC_RorJQCao9xf9pg3Fvw\"\n },\n \"num_committed_segments\": 0,\n \"num_search_segments\": 1,\n \"segments\": {\n \"_0\": {\n \"generation\": 0,\n \"num_docs\": 1,\n \"deleted_docs\": 0,\n \"size_in_bytes\": 3800,\n \"committed\": false,\n \"search\": true,\n \"version\": \"7.0.0\",\n \"compound\": true,\n \"attributes\": {}\n }\n }\n }\n ]\n }\n }\n }\n}" indices.clone-200: description: '' content: application/json: schema: type: object properties: acknowledged: type: boolean index: allOf: - $ref: '#/components/schemas/_types.IndexName' shards_acknowledged: type: boolean required: - acknowledged - index - shards_acknowledged indices.put_index_template-200: description: '' content: application/json: schema: $ref: '#/components/schemas/_types.AcknowledgedResponseBase' indices.segments-200: description: '' content: application/json: schema: type: object properties: indices: type: object additionalProperties: $ref: '#/components/schemas/indices.segments.IndexSegment' _shards: allOf: - $ref: '#/components/schemas/_types.ShardStatistics' required: - indices - _shards examples: indicesSegmentsResponseExample1: description: A response describing information about index segments. value: "{\n \"_shards\": {\n \"total\": 2,\n \"successful\": 2,\n \"failed\": 0\n },\n \"indices\": {\n \"kibana_sample_data_ecommerce\": {\n \"shards\": {\n \"0\": [\n {\n \"routing\": {\n \"state\": \"STARTED\",\n \"primary\": false,\n \"node\": \"zZg9NuPhQPKO3LMRkMo2iw\"\n },\n \"num_committed_segments\": 4,\n \"num_search_segments\": 4,\n \"segments\": {\n \"_0\": {\n \"generation\": 0,\n \"num_docs\": 500,\n \"deleted_docs\": 0,\n \"size_in_bytes\": 524718,\n \"committed\": true,\n \"search\": true,\n \"version\": \"10.3.1\",\n \"compound\": true,\n \"attributes\": {\n \"Lucene90StoredFieldsFormat.mode\": \"BEST_SPEED\"\n }\n },\n \"_1\": {\n \"generation\": 1,\n \"num_docs\": 500,\n \"deleted_docs\": 0,\n \"size_in_bytes\": 526100,\n \"committed\": true,\n \"search\": true,\n \"version\": \"10.3.1\",\n \"compound\": true,\n \"attributes\": {\n \"Lucene90StoredFieldsFormat.mode\": \"BEST_SPEED\"\n }\n },\n \"_2\": {\n \"generation\": 2,\n \"num_docs\": 2000,\n \"deleted_docs\": 0,\n \"size_in_bytes\": 1846181,\n \"committed\": true,\n \"search\": true,\n \"version\": \"10.3.1\",\n \"compound\": true,\n \"attributes\": {\n \"Lucene90StoredFieldsFormat.mode\": \"BEST_SPEED\"\n }\n },\n \"_3\": {\n \"generation\": 3,\n \"num_docs\": 1675,\n \"deleted_docs\": 0,\n \"size_in_bytes\": 1572960,\n \"committed\": true,\n \"search\": true,\n \"version\": \"10.3.1\",\n \"compound\": true,\n \"attributes\": {\n \"Lucene90StoredFieldsFormat.mode\": \"BEST_SPEED\"\n }\n }\n }\n },\n {\n \"routing\": {\n \"state\": \"STARTED\",\n \"primary\": true,\n \"node\": \"sp27SQiNTQWKpBKoRcnfQQ\"\n },\n \"num_committed_segments\": 5,\n \"num_search_segments\": 5,\n \"segments\": {\n \"_0\": {\n \"generation\": 0,\n \"num_docs\": 187,\n \"deleted_docs\": 0,\n \"size_in_bytes\": 227245,\n \"committed\": true,\n \"search\": true,\n \"version\": \"10.3.1\",\n \"compound\": true,\n \"attributes\": {\n \"Lucene90StoredFieldsFormat.mode\": \"BEST_SPEED\"\n }\n },\n \"_1\": {\n \"generation\": 1,\n \"num_docs\": 253,\n \"deleted_docs\": 0,\n \"size_in_bytes\": 297549,\n \"committed\": true,\n \"search\": true,\n \"version\": \"10.3.1\",\n \"compound\": true,\n \"attributes\": {\n \"Lucene90StoredFieldsFormat.mode\": \"BEST_SPEED\"\n }\n },\n \"_2\": {\n \"generation\": 2,\n \"num_docs\": 560,\n \"deleted_docs\": 0,\n \"size_in_bytes\": 580918,\n \"committed\": true,\n \"search\": true,\n \"version\": \"10.3.1\",\n \"compound\": true,\n \"attributes\": {\n \"Lucene90StoredFieldsFormat.mode\": \"BEST_SPEED\"\n }\n },\n \"_3\": {\n \"generation\": 3,\n \"num_docs\": 1603,\n \"deleted_docs\": 0,\n \"size_in_bytes\": 1506385,\n \"committed\": true,\n \"search\": true,\n \"version\": \"10.3.1\",\n \"compound\": true,\n \"attributes\": {\n \"Lucene90StoredFieldsFormat.mode\": \"BEST_SPEED\"\n }\n },\n \"_4\": {\n \"generation\": 4,\n \"num_docs\": 2072,\n \"deleted_docs\": 0,\n \"size_in_bytes\": 1913051,\n \"committed\": true,\n \"search\": true,\n \"version\": \"10.3.1\",\n \"compound\": true,\n \"attributes\": {\n \"Lucene90StoredFieldsFormat.mode\": \"BEST_SPEED\"\n }\n }\n }\n }\n ]\n }\n }\n }\n}" indices.forcemerge-200: description: '' content: application/json: schema: $ref: '#/components/schemas/indices.forcemerge._types.ForceMergeResponseBody' indices.simulate_template-200: description: '' content: application/json: schema: type: object properties: overlapping: type: array items: $ref: '#/components/schemas/indices.simulate_template.Overlapping' template: allOf: - $ref: '#/components/schemas/indices.simulate_template.Template' required: - template examples: indicesSimulateTemplateResponseExample2: description: 'A successful response from `POST /_index_template/_simulate` with a template configuration in the request body. The response shows any overlapping templates with a lower priority. ' value: "{\n \"template\" : {\n \"settings\" : {\n \"index\" : {\n \"number_of_replicas\" : \"1\",\n \"routing\" : {\n \"allocation\" : {\n \"include\" : {\n \"_tier_preference\" : \"data_content\"\n }\n }\n }\n }\n },\n \"mappings\" : {\n \"properties\" : {\n \"@timestamp\" : {\n \"type\" : \"date\"\n }\n }\n },\n \"aliases\" : { }\n },\n \"overlapping\" : [\n {\n \"name\" : \"final-template\",\n \"index_patterns\" : [\n \"my-index-*\"\n ]\n }\n ]\n}" indices.get_template-200: description: '' content: application/json: schema: type: object additionalProperties: $ref: '#/components/schemas/indices._types.TemplateMapping' indices.validate_query-200: description: '' content: application/json: schema: type: object properties: explanations: type: array items: $ref: '#/components/schemas/indices.validate_query.IndicesValidationExplanation' _shards: allOf: - $ref: '#/components/schemas/_types.ShardStatistics' valid: type: boolean error: type: string required: - valid indices.split-200: description: '' content: application/json: schema: type: object properties: acknowledged: type: boolean shards_acknowledged: type: boolean index: allOf: - $ref: '#/components/schemas/_types.IndexName' required: - acknowledged - shards_acknowledged - index indices.put_template-200: description: '' content: application/json: schema: $ref: '#/components/schemas/_types.AcknowledgedResponseBase' indices.put_mapping-200: description: '' content: application/json: schema: $ref: '#/components/schemas/_types.IndicesResponseBase' indices.shrink-200: description: '' content: application/json: schema: type: object properties: acknowledged: type: boolean shards_acknowledged: type: boolean index: allOf: - $ref: '#/components/schemas/_types.IndexName' required: - acknowledged - shards_acknowledged - index indices.stats-200: description: '' content: application/json: schema: type: object properties: indices: type: object additionalProperties: $ref: '#/components/schemas/indices.stats.IndicesStats' _shards: allOf: - $ref: '#/components/schemas/_types.ShardStatistics' _all: allOf: - $ref: '#/components/schemas/indices.stats.IndicesStats' required: - _shards - _all indices.reload_search_analyzers-200: description: '' content: application/json: schema: $ref: '#/components/schemas/indices.reload_search_analyzers.ReloadResult' examples: ReloadSearchAnalyzersResponseExample1: description: A successful response when reloading a search analyzer of an index. value: "{\n \"template\": {\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"mappings\": {\n \"_source\": {\n \"enabled\": false\n },\n \"properties\": {\n \"host_name\": {\n \"type\": \"keyword\"\n },\n \"created_at\": {\n \"type\": \"date\",\n \"format\": \"EEE MMM dd HH:mm:ss Z yyyy\"\n }\n }\n }\n }\n}" indices.get_mapping-200: description: '' content: application/json: schema: type: object additionalProperties: $ref: '#/components/schemas/indices.get_mapping.IndexMappingRecord' indices.flush-200: description: '' content: application/json: schema: $ref: '#/components/schemas/_types.ShardsOperationResponseBase' indices.get_index_template-200: description: '' content: application/json: schema: type: object properties: index_templates: type: array items: $ref: '#/components/schemas/indices.get_index_template.IndexTemplateItem' required: - index_templates examples: GetIndexTemplateResponseExample1: description: A successful response for retrieving information about an index template. value: "{\n \"index_templates\" : [\n {\n \"name\" : \"my-index-template\",\n \"index_template\" : {\n \"index_patterns\" : [ \"logs-*\" ],\n \"template\" : {\n \"settings\" : {\n \"index\" : {\n \"number_of_shards\" : \"1\",\n \"number_of_replicas\" : \"1\"\n }\n },\n \"mappings\" : {\n \"properties\" : {\n \"@timestamp\" : {\n \"type\" : \"date\"\n },\n \"message\" : {\n \"type\" : \"text\"\n }\n }\n }\n },\n \"composed_of\" : [ \"my-component-template\" ],\n \"priority\" : 200,\n \"version\" : 1,\n \"_meta\" : {\n \"description\" : \"my custom index template\"\n },\n \"created_date\" : \"2024-01-01T12:00:00.000Z\",\n \"created_date_millis\" : 1704110400000,\n \"modified_date\" : \"2025-01-01T12:00:00.000Z\",\n \"modified_date_millis\" : 1735732800000\n }\n }\n ]\n}" indices.delete_alias-200: description: '' content: application/json: schema: $ref: '#/components/schemas/indices.delete_alias.IndicesAliasesResponseBody' indices.put_settings-200: description: '' content: application/json: schema: $ref: '#/components/schemas/_types.AcknowledgedResponseBase' indices.get_field_mapping-200: description: '' content: application/json: schema: type: object additionalProperties: $ref: '#/components/schemas/indices.get_field_mapping.TypeFieldMappings' examples: indicesGetFieldMappingResponseExample1: summary: A single field mapping description: 'A sucessful response from `GET publications/_mapping/field/title`, which returns the mapping of a field called `title`. ' value: "{\n \"publications\": {\n \"mappings\": {\n \"title\": {\n \"full_name\": \"title\",\n \"mapping\": {\n \"title\": {\n \"type\": \"text\"\n }\n }\n }\n }\n }\n}" indicesGetFieldMappingResponseExample2: summary: Multiple field mappings description: 'A successful response from `GET publications/_mapping/field/author.id,abstract,name`. The get field mapping API also supports wildcard notation. ' value: "{\n \"publications\": {\n \"mappings\": {\n \"author.id\": {\n \"full_name\": \"author.id\",\n \"mapping\": {\n \"id\": {\n \"type\": \"text\"\n }\n }\n },\n \"abstract\": {\n \"full_name\": \"abstract\",\n \"mapping\": {\n \"abstract\": {\n \"type\": \"text\"\n }\n }\n }\n }\n }\n}" indicesGetFieldMappingResponseExample3: summary: Wildcards description: 'A successful response from `GET publications/_mapping/field/a*`. ' value: "{\n \"publications\": {\n \"mappings\": {\n \"author.name\": {\n \"full_name\": \"author.name\",\n \"mapping\": {\n \"name\": {\n \"type\": \"text\"\n }\n }\n },\n \"abstract\": {\n \"full_name\": \"abstract\",\n \"mapping\": {\n \"abstract\": {\n \"type\": \"text\"\n }\n }\n },\n \"author.id\": {\n \"full_name\": \"author.id\",\n \"mapping\": {\n \"id\": {\n \"type\": \"text\"\n }\n }\n }\n }\n }\n}" indices.recovery-200: description: '' content: application/json: schema: type: object additionalProperties: $ref: '#/components/schemas/indices.recovery.RecoveryStatus' examples: indicesRecoveryResponseExample1: summary: Get segment information description: 'A successful response from `GET /_recovery?human`, which gets information about ongoing and completed shard recoveries for all data streams and indices in a cluster. This example includes information about a single index recovering a single shard. The source of the recovery is a snapshot repository and the target of the recovery is the `my_es_node` node. The response also includes the number and percentage of files and bytes recovered. ' value: "{\n \"index1\" : {\n \"shards\" : [ {\n \"id\" : 0,\n \"type\" : \"SNAPSHOT\",\n \"stage\" : \"INDEX\",\n \"primary\" : true,\n \"start_time\" : \"2014-02-24T12:15:59.716\",\n \"start_time_in_millis\": 1393244159716,\n \"stop_time\" : \"0s\",\n \"stop_time_in_millis\" : 0,\n \"total_time\" : \"2.9m\",\n \"total_time_in_millis\" : 175576,\n \"source\" : {\n \"repository\" : \"my_repository\",\n \"snapshot\" : \"my_snapshot\",\n \"index\" : \"index1\",\n \"version\" : \"{version}\",\n \"restoreUUID\": \"PDh1ZAOaRbiGIVtCvZOMww\"\n },\n \"target\" : {\n \"id\" : \"ryqJ5lO5S4-lSFbGntkEkg\",\n \"host\" : \"my.fqdn\",\n \"transport_address\" : \"my.fqdn\",\n \"ip\" : \"10.0.1.7\",\n \"name\" : \"my_es_node\"\n },\n \"index\" : {\n \"size\" : {\n \"total\" : \"75.4mb\",\n \"total_in_bytes\" : 79063092,\n \"reused\" : \"0b\",\n \"reused_in_bytes\" : 0,\n \"recovered\" : \"65.7mb\",\n \"recovered_in_bytes\" : 68891939,\n \"recovered_from_snapshot\" : \"0b\",\n \"recovered_from_snapshot_in_bytes\" : 0,\n \"percent\" : \"87.1%\"\n },\n \"files\" : {\n \"total\" : 73,\n \"reused\" : 0,\n \"recovered\" : 69,\n \"percent\" : \"94.5%\"\n },\n \"total_time\" : \"0s\",\n \"total_time_in_millis\" : 0,\n \"source_throttle_time\" : \"0s\",\n \"source_throttle_time_in_millis\" : 0,\n \"target_throttle_time\" : \"0s\",\n \"target_throttle_time_in_millis\" : 0\n },\n \"translog\" : {\n \"recovered\" : 0,\n \"total\" : 0,\n \"percent\" : \"100.0%\",\n \"total_on_start\" : 0,\n \"total_time\" : \"0s\",\n \"total_time_in_millis\" : 0\n },\n \"verify_index\" : {\n \"check_index_time\" : \"0s\",\n \"check_index_time_in_millis\" : 0,\n \"total_time\" : \"0s\",\n \"total_time_in_millis\" : 0\n }\n } ]\n }\n}" indicesRecoveryResponseExample2: summary: Get detailed recovery information description: 'A successful response from `GET _recovery?human&detailed=true`. The response includes a listing of any physical files recovered and their sizes. The response also includes timings in milliseconds of the various stages of recovery: index retrieval, translog replay, and index start time. This response indicates the recovery is done. ' value: "{\n \"index1\" : {\n \"shards\" : [ {\n \"id\" : 0,\n \"type\" : \"EXISTING_STORE\",\n \"stage\" : \"DONE\",\n \"primary\" : true,\n \"start_time\" : \"2014-02-24T12:38:06.349\",\n \"start_time_in_millis\" : \"1393245486349\",\n \"stop_time\" : \"2014-02-24T12:38:08.464\",\n \"stop_time_in_millis\" : \"1393245488464\",\n \"total_time\" : \"2.1s\",\n \"total_time_in_millis\" : 2115,\n \"source\" : {\n \"id\" : \"RGMdRc-yQWWKIBM4DGvwqQ\",\n \"host\" : \"my.fqdn\",\n \"transport_address\" : \"my.fqdn\",\n \"ip\" : \"10.0.1.7\",\n \"name\" : \"my_es_node\"\n },\n \"target\" : {\n \"id\" : \"RGMdRc-yQWWKIBM4DGvwqQ\",\n \"host\" : \"my.fqdn\",\n \"transport_address\" : \"my.fqdn\",\n \"ip\" : \"10.0.1.7\",\n \"name\" : \"my_es_node\"\n },\n \"index\" : {\n \"size\" : {\n \"total\" : \"24.7mb\",\n \"total_in_bytes\" : 26001617,\n \"reused\" : \"24.7mb\",\n \"reused_in_bytes\" : 26001617,\n \"recovered\" : \"0b\",\n \"recovered_in_bytes\" : 0,\n \"recovered_from_snapshot\" : \"0b\",\n \"recovered_from_snapshot_in_bytes\" : 0,\n \"percent\" : \"100.0%\"\n },\n \"files\" : {\n \"total\" : 26,\n \"reused\" : 26,\n \"recovered\" : 0,\n \"percent\" : \"100.0%\",\n \"details\" : [ {\n \"name\" : \"segments.gen\",\n \"length\" : 20,\n \"recovered\" : 20\n }, {\n \"name\" : \"_0.cfs\",\n \"length\" : 135306,\n \"recovered\" : 135306,\n \"recovered_from_snapshot\": 0\n }, {\n \"name\" : \"segments_2\",\n \"length\" : 251,\n \"recovered\" : 251,\n \"recovered_from_snapshot\": 0\n }\n ]\n },\n \"total_time\" : \"2ms\",\n \"total_time_in_millis\" : 2,\n \"source_throttle_time\" : \"0s\",\n \"source_throttle_time_in_millis\" : 0,\n \"target_throttle_time\" : \"0s\",\n \"target_throttle_time_in_millis\" : 0\n },\n \"translog\" : {\n \"recovered\" : 71,\n \"total\" : 0,\n \"percent\" : \"100.0%\",\n \"total_on_start\" : 0,\n \"total_time\" : \"2.0s\",\n \"total_time_in_millis\" : 2025\n },\n \"verify_index\" : {\n \"check_index_time\" : 0,\n \"check_index_time_in_millis\" : 0,\n \"total_time\" : \"88ms\",\n \"total_time_in_millis\" : 88\n }\n } ]\n }\n}" indices.get_alias-200: description: '' content: application/json: schema: type: object additionalProperties: $ref: '#/components/schemas/indices.get_alias._types.IndexAliases' indices.put_alias-200: description: '' content: application/json: schema: $ref: '#/components/schemas/_types.AcknowledgedResponseBase' indices.refresh-200: description: '' content: application/json: schema: $ref: '#/components/schemas/_types.ShardsOperationResponseBase' indices.analyze-200: description: '' content: application/json: schema: type: object properties: detail: allOf: - $ref: '#/components/schemas/indices.analyze.AnalyzeDetail' tokens: type: array items: $ref: '#/components/schemas/indices.analyze.AnalyzeToken' examples: indicesAnalyzeResponseExample7: description: A successful response for an analysis with `explain` set to `true`. value: "{\n \"detail\": {\n \"custom_analyzer\": true,\n \"charfilters\": [],\n \"tokenizer\": {\n \"name\": \"standard\",\n \"tokens\": [\n {\n \"token\": \"detailed\",\n \"start_offset\": 0,\n \"end_offset\": 8,\n \"type\": \"\",\n \"position\": 0\n },\n {\n \"token\": \"output\",\n \"start_offset\": 9,\n \"end_offset\": 15,\n \"type\": \"\",\n \"position\": 1\n }\n ]\n },\n \"tokenfilters\": [\n {\n \"name\": \"snowball\",\n \"tokens\": [\n {\n \"token\": \"detail\",\n \"start_offset\": 0,\n \"end_offset\": 8,\n \"type\": \"\",\n \"position\": 0,\n \"keyword\": false\n },\n {\n \"token\": \"output\",\n \"start_offset\": 9,\n \"end_offset\": 15,\n \"type\": \"\",\n \"position\": 1,\n \"keyword\": false\n }\n ]\n }\n ]\n }\n}" indices.exists_alias-200: description: '' content: application/json: {} indices.get_settings-200: description: '' content: application/json: schema: type: object additionalProperties: $ref: '#/components/schemas/indices._types.IndexState' indices.resolve_cluster-200: description: '' content: application/json: schema: type: object additionalProperties: $ref: '#/components/schemas/indices.resolve_cluster.ResolveClusterInfo' examples: ResolveClusterResponseExample1: summary: Resolve with wildcards description: 'A successful response from `GET /_resolve/cluster/my-index*,clust*:my-index*`. Each cluster has its own response section. The cluster you sent the request to is labelled as "(local)". ' value: "{\n \"(local)\": {\n \"connected\": true,\n \"skip_unavailable\": false,\n \"matching_indices\": true,\n \"version\": {\n \"number\": \"8.13.0\",\n \"build_flavor\": \"default\",\n \"minimum_wire_compatibility_version\": \"7.17.0\",\n \"minimum_index_compatibility_version\": \"7.0.0\"\n }\n },\n \"cluster_one\": {\n \"connected\": true,\n \"skip_unavailable\": true,\n \"matching_indices\": true,\n \"version\": {\n \"number\": \"8.13.0\",\n \"build_flavor\": \"default\",\n \"minimum_wire_compatibility_version\": \"7.17.0\",\n \"minimum_index_compatibility_version\": \"7.0.0\"\n }\n },\n \"cluster_two\": {\n \"connected\": true,\n \"skip_unavailable\": false,\n \"matching_indices\": true,\n \"version\": {\n \"number\": \"8.13.0\",\n \"build_flavor\": \"default\",\n \"minimum_wire_compatibility_version\": \"7.17.0\",\n \"minimum_index_compatibility_version\": \"7.0.0\"\n }\n }\n}" ResolveClusterResponseExample2: summary: Identify search problems description: 'A successful response from `GET /_resolve/cluster/not-present,clust*:my-index*,oldcluster:*?ignore_unavailable=false&timeout=5s`. This type of request can be used to identify potential problems with your cross-cluster search. Note also that a `timeout` of 5 seconds is sent, which sets the maximum time the query will wait for remote clusters to respond. The local cluster has no index called `not_present`. Searching with `ignore_unavailable=false` would return a "no such index" error. The `cluster_one` remote cluster has no indices that match the pattern `my-index*`. There may be no indices that match the pattern or the index could be closed. The `cluster_two` remote cluster is not connected (the attempt to connect failed). Since this cluster is marked as `skip_unavailable=false`, you should probably exclude this cluster from the search by adding `-cluster_two:*` to the search index expression. For `cluster_three`, the error message indicates that this remote cluster did not respond within the 5-second timeout window specified, so it is also marked as not connected. The `oldcluster` remote cluster shows that it has matching indices, but no version information is included. This indicates that the cluster version predates the introduction of the `_resolve/cluster` API, so you may want to exclude it from your cross-cluster search. ' value: "{\n \"(local)\": {\n \"connected\": true,\n \"skip_unavailable\": false,\n \"error\": \"no such index [not_present]\"\n },\n \"cluster_one\": {\n \"connected\": true,\n \"skip_unavailable\": true,\n \"matching_indices\": false,\n \"version\": {\n \"number\": \"8.13.0\",\n \"build_flavor\": \"default\",\n \"minimum_wire_compatibility_version\": \"7.17.0\",\n \"minimum_index_compatibility_version\": \"7.0.0\"\n }\n },\n \"cluster_two\": {\n \"connected\": false,\n \"skip_unavailable\": false\n },\n \"cluster_three\": {\n \"connected\": false,\n \"skip_unavailable\": false,\n \"error\": \"Request timed out before receiving a response from the remote cluster\"\n },\n \"oldcluster\": {\n \"connected\": true,\n \"skip_unavailable\": false,\n \"matching_indices\": true\n }\n}" parameters: indices.clone-wait_for_active_shards: in: query name: wait_for_active_shards description: 'The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).' deprecated: false schema: default: '1' allOf: - $ref: '#/components/schemas/_types.WaitForActiveShards' style: form indices.validate_query-all_shards: in: query name: all_shards description: If `true`, the validation is executed on all shards instead of one random shard per index. deprecated: false schema: default: false type: boolean style: form indices.forcemerge-flush: in: query name: flush description: Specify whether the index should be flushed after performing the operation deprecated: false schema: default: true type: boolean style: form indices.get_alias-index: in: path name: index description: 'Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple indices.clone-index: in: path name: index description: Name of the source index to clone. required: true deprecated: false schema: $ref: '#/components/schemas/_types.IndexName' style: simple indices.stats-index: in: path name: index description: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple indices.put_mapping-master_timeout: in: query name: master_timeout 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.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form indices.get_settings-expand_wildcards: in: query name: expand_wildcards description: 'Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.' deprecated: false schema: default: open allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form indices.recovery-active_only: in: query name: active_only description: If `true`, the response only includes ongoing shard recoveries. deprecated: false schema: default: false type: boolean style: form indices.stats-expand_wildcards: in: query name: expand_wildcards description: 'Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.' deprecated: false schema: default: open allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form indices.get_template-flat_settings: in: query name: flat_settings description: If `true`, returns settings in flat format. deprecated: false schema: default: false type: boolean style: form indices.reload_search_analyzers-resource: in: query name: resource description: Changed resource to reload analyzers from if applicable deprecated: false schema: type: string style: form indices.exists_alias-ignore_unavailable: in: query name: ignore_unavailable description: 'If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.' deprecated: false schema: default: false type: boolean style: form indices.exists_alias-expand_wildcards: in: query name: expand_wildcards description: 'Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.' deprecated: false schema: default: all allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form indices.stats-include_unloaded_segments: in: query name: include_unloaded_segments description: If true, the response includes information from segments that are not loaded into memory. deprecated: false schema: default: false type: boolean style: form indices.get_mapping-local: in: query name: local description: If `true`, the request retrieves information from the local node only. deprecated: true schema: default: false type: boolean style: form indices.rollover-dry_run: in: query name: dry_run description: If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover. deprecated: false schema: default: false type: boolean style: form indices.get_mapping-master_timeout: in: query name: master_timeout 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.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form indices.rollover-master_timeout: in: query name: master_timeout 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.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form indices.refresh-index: in: path name: index description: 'Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple indices.validate_query-rewrite: in: query name: rewrite description: If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed. deprecated: false schema: default: false type: boolean style: form indices.shrink-timeout: in: query name: timeout description: 'Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form indices.resolve_cluster-ignore_unavailable: in: query name: ignore_unavailable description: 'If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the `_resolve/cluster` API endpoint that takes no index expression.' deprecated: false schema: default: false type: boolean style: form indices.put_alias-master_timeout: in: query name: master_timeout 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.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form indices.simulate_template-create: in: query name: create description: If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. deprecated: false schema: default: false type: boolean style: form indices.get_index_template-local: in: query name: local description: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. deprecated: true schema: default: false type: boolean style: form indices.get_index_template-master_timeout: in: query name: master_timeout 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. deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form indices.forcemerge-expand_wildcards: in: query name: expand_wildcards description: Whether to expand wildcard expression to concrete indices that are open, closed or both. deprecated: false schema: default: open allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form indices.put_template-master_timeout: in: query name: master_timeout 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.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form indices.get_alias-master_timeout: in: query name: master_timeout 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.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form indices.resolve_cluster-expand_wildcards: in: query name: expand_wildcards description: 'Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the `_resolve/cluster` API endpoint that takes no index expression.' deprecated: false schema: default: open allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form indices.get_mapping-index: in: path name: index description: 'Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple indices.validate_query-explain: in: query name: explain description: If `true`, the response returns detailed information if an error has occurred. deprecated: false schema: default: false type: boolean style: form indices.delete_alias-timeout: in: query name: timeout description: 'Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form indices.put_settings-expand_wildcards: in: query name: expand_wildcards description: 'Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.' deprecated: false schema: default: open allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form indices.stats-completion_fields: in: query name: completion_fields description: Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. deprecated: false schema: $ref: '#/components/schemas/_types.Fields' style: form indices.validate_query-lenient: in: query name: lenient description: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. deprecated: false schema: default: false type: boolean style: form indices.split-timeout: in: query name: timeout description: 'Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form indices.put_settings-allow_no_indices: in: query name: allow_no_indices description: 'A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.' deprecated: false schema: default: false type: boolean style: form indices.get_settings-flat_settings: in: query name: flat_settings description: If `true`, returns settings in flat format. deprecated: false schema: default: false type: boolean style: form indices.reload_search_analyzers-ignore_unavailable: in: query name: ignore_unavailable description: 'If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.' deprecated: false schema: type: boolean style: form indices.clear_cache-index_: in: query name: index description: 'Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.' deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: form indices.put_mapping-write_index_only: in: query name: write_index_only description: If `true`, the mappings are applied only to the current write index for the target. deprecated: false schema: default: false type: boolean style: form indices.clone-timeout: in: query name: timeout description: 'Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form indices.simulate_template-master_timeout: in: query name: master_timeout 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. deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form indices.analyze-index_: in: query name: index description: 'Index used to derive the analyzer. If specified, the `analyzer` or field parameter overrides this value. If no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.' deprecated: false schema: $ref: '#/components/schemas/_types.IndexName' style: form indices.validate_query-index: in: path name: index description: 'Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this parameter or use `*` or `_all`.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple indices.rollover-new_index: in: path name: new_index description: 'Name of the index to create. Supports date math. Data streams do not support this parameter.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.IndexName' style: simple indices.delete_alias-index: in: path name: index description: 'Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`).' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple indices.rollover-wait_for_active_shards: in: query name: wait_for_active_shards description: 'The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).' deprecated: false schema: default: '1' allOf: - $ref: '#/components/schemas/_types.WaitForActiveShards' style: form indices.validate_query-df: in: query name: df description: 'Field to use as default where no field prefix is given in the query string. This parameter can only be used when the `q` query string parameter is specified.' deprecated: false schema: type: string style: form cluster.put_component_template-master_timeout: in: query name: master_timeout 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.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form indices.resolve_cluster-timeout: in: query name: timeout description: 'The maximum time to wait for remote clusters to respond. If a remote cluster does not respond within this timeout period, the API response will show the cluster as not connected and include an error message that the request timed out. The default timeout is unset and the query can take as long as the networking layer is configured to wait for remote clusters that are not responding (typically 30 seconds).' deprecated: false schema: $ref: '#/components/schemas/_types.Duration' style: form indices.clear_cache-fields: in: query name: fields description: Comma-separated list of field names used to limit the `fielddata` parameter. deprecated: false schema: $ref: '#/components/schemas/_types.Fields' style: form indices.flush-wait_if_ongoing: in: query name: wait_if_ongoing description: 'If `true`, the flush operation blocks until execution when another flush operation is running. If `false`, Elasticsearch returns an error if you request a flush when another flush operation is running.' deprecated: false schema: default: true type: boolean style: form indices.get_field_mapping-expand_wildcards: in: query name: expand_wildcards description: 'Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.' deprecated: false schema: default: open allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form indices.refresh-allow_no_indices: in: query name: allow_no_indices description: 'A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.' deprecated: false schema: default: true type: boolean style: form cluster.get_component_template-local: in: query name: local description: 'If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node.' deprecated: true schema: default: false type: boolean style: form indices.get_template-master_timeout: in: query name: master_timeout 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.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form indices.put_template-name: in: path name: name description: The name of the template required: true deprecated: false schema: $ref: '#/components/schemas/_types.Name' style: simple indices.clone-target: in: path name: target description: Name of the target index to create. required: true deprecated: false schema: $ref: '#/components/schemas/_types.Name' style: simple indices.resolve_index-name: in: path name: name description: 'Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified using the ``:`` syntax.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Names' style: simple indices.recovery-allow_no_indices: in: query name: allow_no_indices description: 'A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.' deprecated: false schema: default: true type: boolean style: form indices.clear_cache-request: in: query name: request description: If `true`, clears the request cache. deprecated: false schema: type: boolean style: form indices.shrink-wait_for_active_shards: in: query name: wait_for_active_shards description: 'The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).' deprecated: false schema: default: '1' allOf: - $ref: '#/components/schemas/_types.WaitForActiveShards' style: form indices.shard_stores-status: in: query name: status description: List of shard health statuses used to limit the request. deprecated: false schema: oneOf: - $ref: '#/components/schemas/indices.shard_stores.ShardStoreStatus' - type: array items: $ref: '#/components/schemas/indices.shard_stores.ShardStoreStatus' style: form indices.get_settings-include_defaults: in: query name: include_defaults description: If `true`, return all default settings in the response. deprecated: false schema: default: false type: boolean style: form indices.clear_cache-query: in: query name: query description: If `true`, clears the query cache. deprecated: false schema: type: boolean style: form indices.stats-groups: in: query name: groups description: Comma-separated list of search groups to include in the search statistics. deprecated: false schema: oneOf: - type: string - type: array items: type: string style: form indices.put_settings-reopen: in: query name: reopen description: 'Whether to close and reopen the index to apply non-dynamic settings. If set to `true` the indices to which the settings are being applied will be closed temporarily and then reopened in order to apply the changes.' deprecated: false schema: default: false type: boolean style: form indices.put_mapping-expand_wildcards: in: query name: expand_wildcards description: 'Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.' deprecated: false schema: default: open allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form indices.validate_query-analyzer: in: query name: analyzer description: 'Analyzer to use for the query string. This parameter can only be used when the `q` query string parameter is specified.' deprecated: false schema: type: string style: form indices.rollover-alias: in: path name: alias description: Name of the data stream or index alias to roll over. required: true deprecated: false schema: $ref: '#/components/schemas/_types.IndexAlias' style: simple indices.get_alias-allow_no_indices: in: query name: allow_no_indices description: 'A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.' deprecated: false schema: default: true type: boolean style: form indices.recovery-expand_wildcards: in: query name: expand_wildcards description: 'Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.' deprecated: false schema: default: open allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form indices.analyze-index: in: path name: index description: 'Index used to derive the analyzer. If specified, the `analyzer` or field parameter overrides this value. If no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.IndexName' style: simple indices.validate_query-q: in: query name: q description: Query in the Lucene query string syntax. deprecated: false schema: type: string style: form indices.reload_search_analyzers-index: in: path name: index description: A comma-separated list of index names to reload analyzers for required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple indices.delete_alias-master_timeout: in: query name: master_timeout 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.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form cluster.get_component_template-name: in: path name: name description: Name of component template to retrieve. Wildcard (`*`) expressions are supported. required: true deprecated: false schema: $ref: '#/components/schemas/_types.Name' style: simple indices.get_field_mapping-index: in: path name: index description: 'Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple indices.shrink-index: in: path name: index description: Name of the source index to shrink. required: true deprecated: false schema: $ref: '#/components/schemas/_types.IndexName' style: simple indices.stats-fielddata_fields: in: query name: fielddata_fields description: Comma-separated list or wildcard expressions of fields to include in fielddata statistics. deprecated: false schema: $ref: '#/components/schemas/_types.Fields' style: form indices.forcemerge-allow_no_indices: in: query name: allow_no_indices description: 'A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.' deprecated: false schema: type: boolean style: form indices.refresh-ignore_unavailable: in: query name: ignore_unavailable description: 'If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.' deprecated: false schema: default: false type: boolean style: form indices.get_settings-name: in: path name: name description: Comma-separated list or wildcard expression of settings to retrieve. required: true deprecated: false schema: $ref: '#/components/schemas/_types.Names' style: simple indices.validate_query-routing: in: query name: routing description: 'A custom value used to route operations to a specific shard. Not allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.' deprecated: false schema: $ref: '#/components/schemas/_types.Routing' x-state: Generally available; Added in 9.5.0 style: form indices.exists_alias-master_timeout: in: query name: master_timeout 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.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form indices.segments-expand_wildcards: in: query name: expand_wildcards description: 'Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.' deprecated: false schema: default: open allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form indices.put_mapping-ignore_unavailable: in: query name: ignore_unavailable description: 'If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.' deprecated: false schema: default: false type: boolean style: form indices.put_mapping-index: in: path name: index description: 'A comma-separated list of index names the mapping should be added to (supports wildcards). Use `_all` or omit to add the mapping on all indices.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple cluster.put_component_template-name: in: path name: name description: 'Name of the component template to create. Elasticsearch includes the following built-in component templates: `logs-mappings`; `logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`. Elastic Agent uses these templates to configure backing indices for its data streams. If you use Elastic Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version. If you don’t use Elastic Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Name' style: simple indices.shard_stores-expand_wildcards: in: query name: expand_wildcards description: 'Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.' deprecated: false schema: default: open allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form indices.put_settings-preserve_existing: in: query name: preserve_existing description: If `true`, existing index settings remain unchanged. deprecated: false schema: default: false type: boolean style: form indices.get_template-name: in: path name: name description: 'Comma-separated list of index template names used to limit the request. Wildcard (`*`) expressions are supported. To return all index templates, omit this parameter or use a value of `_all` or `*`.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Names' style: simple indices.validate_query-analyze_wildcard: in: query name: analyze_wildcard description: If `true`, wildcard and prefix queries are analyzed. deprecated: false schema: default: false type: boolean style: form indices.clear_cache-ignore_unavailable: in: query name: ignore_unavailable description: 'If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.' deprecated: false schema: default: false type: boolean style: form cluster.get_component_template-master_timeout: in: query name: master_timeout 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.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form indices.stats-level: in: query name: level description: Indicates whether statistics are aggregated at the cluster, indices, or shards level. deprecated: false schema: default: indices allOf: - $ref: '#/components/schemas/_types.Level' style: form indices.clear_cache-allow_no_indices: in: query name: allow_no_indices description: 'A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.' deprecated: false schema: default: true type: boolean style: form indices.flush-allow_no_indices: in: query name: allow_no_indices description: 'A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.' deprecated: false schema: default: true type: boolean style: form indices.get_field_mapping-include_defaults: in: query name: include_defaults description: If `true`, return all default settings in the response. deprecated: false schema: default: false type: boolean style: form indices.get_field_mapping-allow_no_indices: in: query name: allow_no_indices description: 'A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.' deprecated: false schema: default: true type: boolean style: form indices.resolve_cluster-name: in: path name: name description: 'A comma-separated list of names or index patterns for the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified using the ``:`` syntax. Index and cluster exclusions (e.g., `-cluster1:*`) are also supported. If no index expression is specified, information about all remote clusters configured on the local cluster is returned without doing any index matching' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Names' style: simple indices.put_index_template-name: in: path name: name description: Index or template name required: true deprecated: false schema: $ref: '#/components/schemas/_types.Name' style: simple indices.resolve_cluster-allow_no_indices: in: query name: allow_no_indices description: 'A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the `_resolve/cluster` API endpoint that takes no index expression.' deprecated: false schema: default: true type: boolean style: form indices.recovery-index: in: path name: index description: 'Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple indices.clear_cache-index: in: path name: index description: 'Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple indices.put_alias-timeout: in: query name: timeout description: 'Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form indices.segments-ignore_unavailable: in: query name: ignore_unavailable description: 'If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.' deprecated: false schema: default: false type: boolean style: form indices.split-wait_for_active_shards: in: query name: wait_for_active_shards description: 'The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).' deprecated: false schema: default: '1' allOf: - $ref: '#/components/schemas/_types.WaitForActiveShards' style: form cluster.get_component_template-flat_settings: in: query name: flat_settings description: If `true`, returns settings in flat format. deprecated: false schema: default: false type: boolean style: form indices.get_alias-name: in: path name: name description: 'Comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Names' style: simple indices.validate_query-allow_no_indices: in: query name: allow_no_indices description: 'A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.' deprecated: false schema: default: true type: boolean style: form indices.get_settings-ignore_unavailable: in: query name: ignore_unavailable description: 'If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.' deprecated: false schema: default: false type: boolean style: form indices.forcemerge-ignore_unavailable: in: query name: ignore_unavailable description: 'If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.' deprecated: false schema: type: boolean style: form indices.put_index_template-create: in: query name: create description: If `true`, this request cannot replace or update existing index templates. deprecated: false schema: default: false type: boolean style: form indices.shrink-target: in: path name: target description: Name of the target index to create. required: true deprecated: false schema: $ref: '#/components/schemas/_types.IndexName' style: simple indices.clone-master_timeout: in: query name: master_timeout 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.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form indices.validate_query-default_operator: in: query name: default_operator description: 'The default operator for query string query: `and` or `or`.' deprecated: false schema: default: or allOf: - $ref: '#/components/schemas/_types.query_dsl.Operator' style: form indices.simulate_template-name: in: path name: name description: 'Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit this parameter and specify the template configuration in the request body.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Name' style: simple indices.resolve_cluster-ignore_throttled: in: query name: ignore_throttled description: 'If true, concrete, expanded, or aliased indices are ignored when frozen. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the `_resolve/cluster` API endpoint that takes no index expression.' deprecated: true schema: default: false type: boolean style: form indices.put_index_template-master_timeout: in: query name: master_timeout 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.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form indices.rollover-lazy: in: query name: lazy description: 'If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. Only allowed on data streams.' deprecated: false schema: default: false type: boolean style: form indices.put_settings-timeout: in: query name: timeout description: "Period to wait for a response. If no response is received before the\n timeout expires, the request fails and returns an error." deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form indices.refresh-expand_wildcards: in: query name: expand_wildcards description: 'Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.' deprecated: false schema: default: open allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form indices.split-index: in: path name: index description: Name of the source index to split. required: true deprecated: false schema: $ref: '#/components/schemas/_types.IndexName' style: simple cluster.get_component_template-settings_filter: in: query name: settings_filter description: Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys deprecated: false schema: oneOf: - type: string - type: array items: type: string style: form indices.put_template-cause: in: query name: cause description: User defined reason for creating or updating the index template deprecated: false schema: default: '' type: string style: form indices.resolve_index-ignore_unavailable: in: query name: ignore_unavailable description: 'If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.' deprecated: false schema: default: false type: boolean style: form indices.stats-forbid_closed_indices: in: query name: forbid_closed_indices description: If true, statistics are not collected from closed indices. deprecated: false schema: default: true type: boolean style: form indices.forcemerge-only_expunge_deletes: in: query name: only_expunge_deletes description: Specify whether the operation should only expunge deleted documents deprecated: false schema: default: false type: boolean style: form cluster.put_component_template-create: in: query name: create description: If `true`, this request cannot replace or update existing component templates. deprecated: false schema: default: false type: boolean style: form indices.flush-index: in: path name: index description: 'Comma-separated list of data streams, indices, and aliases to flush. Supports wildcards (`*`). To flush all data streams and indices, omit this parameter or use `*` or `_all`.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple indices.get_settings-index: in: path name: index description: 'Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple indices.forcemerge-wait_for_completion: in: query name: wait_for_completion description: Should the request wait until the force merge is completed deprecated: false schema: default: true type: boolean style: form indices.flush-expand_wildcards: in: query name: expand_wildcards description: 'Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.' deprecated: false schema: default: open allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form indices.reload_search_analyzers-expand_wildcards: in: query name: expand_wildcards description: Whether to expand wildcard expression to concrete indices that are open, closed or both. deprecated: false schema: default: open allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form indices.validate_query-ignore_unavailable: in: query name: ignore_unavailable description: 'If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.' deprecated: false schema: default: false type: boolean style: form cluster.put_component_template-cause: in: query name: cause description: User defined reason for create the component template. deprecated: false schema: default: api type: string style: form indices.get_mapping-allow_no_indices: in: query name: allow_no_indices description: 'A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.' deprecated: false schema: default: true type: boolean style: form indices.put_mapping-allow_no_indices: in: query name: allow_no_indices description: 'A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.' deprecated: false schema: default: true type: boolean style: form indices.rollover-timeout: in: query name: timeout description: 'Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form indices.resolve_index-allow_no_indices: in: query name: allow_no_indices description: 'A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.' deprecated: false schema: default: true type: boolean style: form indices.segments-index: in: path name: index description: 'Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple indices.get_index_template-name: in: path name: name description: Name of index template to retrieve. Wildcard (*) expressions are supported. required: true deprecated: false schema: $ref: '#/components/schemas/_types.Name' style: simple indices.resolve_index-expand_wildcards: in: query name: expand_wildcards description: 'Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.' deprecated: false schema: default: open allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form indices.stats-include_segment_file_sizes: in: query name: include_segment_file_sizes description: If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). deprecated: false schema: default: false type: boolean style: form indices.exists_alias-index: in: path name: index description: 'Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple indices.put_settings-ignore_unavailable: in: query name: ignore_unavailable description: 'If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.' deprecated: false schema: default: false type: boolean style: form indices.get_settings-allow_no_indices: in: query name: allow_no_indices description: 'A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.' deprecated: false schema: default: true type: boolean style: form indices.split-target: in: path name: target description: Name of the target index to create. required: true deprecated: false schema: $ref: '#/components/schemas/_types.IndexName' style: simple indices.get_field_mapping-fields: in: path name: fields description: 'Comma-separated list or wildcard expression of fields used to limit returned information. Supports wildcards (`*`).' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Fields' style: simple indices.reload_search_analyzers-allow_no_indices: in: query name: allow_no_indices description: 'A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.' deprecated: false schema: type: boolean style: form indices.put_settings-master_timeout: in: query name: master_timeout 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.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form indices.get_field_mapping-ignore_unavailable: in: query name: ignore_unavailable description: 'If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.' deprecated: false schema: default: false type: boolean style: form indices.simulate_template-include_defaults: in: query name: include_defaults description: If true, returns all relevant default configurations for the index template. deprecated: false schema: default: false type: boolean x-state: Generally available; Added in 8.11.0 style: form indices.shrink-master_timeout: in: query name: master_timeout 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.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form indices.resolve_index-mode: in: query name: mode description: Filter indices by index mode - standard, lookup, time_series, etc. Comma-separated list of IndexMode. Empty means no filter. deprecated: false schema: oneOf: - $ref: '#/components/schemas/indices._types.IndexMode' - type: array items: $ref: '#/components/schemas/indices._types.IndexMode' x-state: Generally available; Added in 9.2.0 style: form indices.validate_query-expand_wildcards: in: query name: expand_wildcards description: 'Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.' deprecated: false schema: default: open allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form indices.put_alias-index: in: path name: index description: 'Comma-separated list of data streams or indices to add. Supports wildcards (`*`). Wildcard patterns that match both data streams and indices return an error.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple indices.get_alias-expand_wildcards: in: query name: expand_wildcards description: 'Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.' deprecated: false schema: default: all allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form indices.put_template-order: in: query name: order description: 'Order in which Elasticsearch applies this template if index matches multiple templates. Templates with lower ''order'' values are merged first. Templates with higher ''order'' values are merged later, overriding templates with lower values.' deprecated: false schema: type: number style: form cluster.get_component_template-include_defaults: in: query name: include_defaults description: Return all default configurations for the component template deprecated: false schema: default: false type: boolean x-state: Generally available; Added in 8.11.0 style: form indices.forcemerge-index: in: path name: index description: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple indices.flush-force: in: query name: force description: If `true`, the request forces a flush even if there are no changes to commit to the index. deprecated: false schema: default: true type: boolean style: form indices.get_index_template-flat_settings: in: query name: flat_settings description: If true, returns settings in flat format. deprecated: false schema: default: false type: boolean style: form indices.forcemerge-max_num_segments: in: query name: max_num_segments description: 'The number of segments the index should be merged into (default: dynamic)' deprecated: false schema: type: number style: form indices.put_index_template-cause: in: query name: cause description: User defined reason for creating or updating the index template deprecated: false schema: default: api type: string style: form indices.clear_cache-expand_wildcards: in: query name: expand_wildcards description: 'Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.' deprecated: false schema: default: open allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form indices.get_template-local: in: query name: local description: If `true`, the request retrieves information from the local node only. deprecated: true schema: default: false type: boolean style: form indices.get_mapping-expand_wildcards: in: query name: expand_wildcards description: 'Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.' deprecated: false schema: default: open allOf: - $ref: '#/components/schemas/_types.ExpandWildcards' style: form indices.exists_alias-name: in: path name: name description: Comma-separated list of aliases to check. Supports wildcards (`*`). required: true deprecated: false schema: $ref: '#/components/schemas/_types.Names' style: simple indices.put_alias-name: in: path name: name description: 'Alias to update. If the alias doesn’t exist, the request creates it. Index alias names support date math.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Name' style: simple indices.simulate_template-cause: in: query name: cause description: User defined reason for dry-run creating the new template for simulation purposes deprecated: false schema: default: 'false' type: string style: form indices.flush-ignore_unavailable: in: query name: ignore_unavailable description: 'If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.' deprecated: false schema: default: false type: boolean style: form indices.stats-fields: in: query name: fields description: Comma-separated list or wildcard expressions of fields to include in the statistics. deprecated: false schema: $ref: '#/components/schemas/_types.Fields' style: form indices.recovery-detailed: in: query name: detailed description: If `true`, the response includes detailed information about shard recoveries. deprecated: false schema: default: false type: boolean style: form indices.put_mapping-timeout: in: query name: timeout description: 'Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form indices.get_index_template-include_defaults: in: query name: include_defaults description: If true, returns all relevant default configurations for the index template. deprecated: false schema: default: false type: boolean x-state: Generally available; Added in 8.11.0 style: form indices.stats-metric: in: path name: metric description: Comma-separated list of metrics used to limit the request. required: true deprecated: false schema: $ref: '#/components/schemas/_types.CommonStatsFlags' style: simple indices.put_settings-index: in: path name: index description: 'Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple indices.shard_stores-index: in: path name: index description: List of data streams, indices, and aliases used to limit the request. required: true deprecated: false schema: $ref: '#/components/schemas/_types.Indices' style: simple indices.clear_cache-fielddata: in: query name: fielddata description: 'If `true`, clears the fields cache. Use the `fields` parameter to clear the cache of specific fields only.' deprecated: false schema: type: boolean style: form indices.shard_stores-allow_no_indices: in: query name: allow_no_indices description: 'A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.' deprecated: false schema: type: boolean style: form indices.put_template-create: in: query name: create description: If true, this request cannot replace or update existing index templates. deprecated: false schema: default: false type: boolean style: form indices.get_settings-local: in: query name: local description: 'If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node.' deprecated: true schema: default: false type: boolean style: form indices.segments-allow_no_indices: in: query name: allow_no_indices description: 'A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.' deprecated: false schema: default: true type: boolean style: form indices.recovery-ignore_unavailable: in: query name: ignore_unavailable description: 'If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.' deprecated: false schema: default: false type: boolean style: form indices.get_alias-ignore_unavailable: in: query name: ignore_unavailable description: 'If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.' deprecated: false schema: default: false type: boolean style: form indices.split-master_timeout: in: query name: master_timeout 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.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form indices.delete_alias-name: in: path name: name description: 'Comma-separated list of aliases to remove. Supports wildcards (`*`). To remove all aliases, use `*` or `_all`.' required: true deprecated: false schema: $ref: '#/components/schemas/_types.Names' style: simple indices.get_mapping-ignore_unavailable: in: query name: ignore_unavailable description: 'If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.' deprecated: false schema: default: false type: boolean style: form indices.shard_stores-ignore_unavailable: in: query name: ignore_unavailable description: 'If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored.' deprecated: false schema: default: false type: boolean style: form indices.put_settings-flat_settings: in: query name: flat_settings description: If `true`, returns settings in flat format. deprecated: false schema: default: false type: boolean style: form indices.get_settings-master_timeout: in: query name: master_timeout 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.' deprecated: false schema: default: 30s allOf: - $ref: '#/components/schemas/_types.Duration' style: form indices.exists_alias-allow_no_indices: in: query name: allow_no_indices description: 'A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result.' deprecated: false schema: default: true type: boolean style: form requestBodies: indices.put_index_template: content: application/json: schema: type: object properties: index_patterns: description: Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation. allOf: - $ref: '#/components/schemas/_types.Indices' composed_of: description: 'An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.' type: array items: $ref: '#/components/schemas/_types.Name' template: description: 'Template to be applied. It may optionally include an `aliases`, `mappings`, or `settings` configuration.' allOf: - $ref: '#/components/schemas/indices.put_index_template.IndexTemplateMapping' data_stream: description: 'If this object is included, the template is used to create data streams and their backing indices. Supports an empty object. Data streams require a matching index template with a `data_stream` object.' allOf: - $ref: '#/components/schemas/indices._types.DataStreamVisibility' priority: description: 'Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by Elasticsearch.' type: number version: description: 'Version number used to manage index templates externally. This number is not automatically generated by Elasticsearch. External systems can use these version numbers to simplify template management. To unset a version, replace the template without specifying one.' allOf: - $ref: '#/components/schemas/_types.VersionNumber' _meta: description: 'Optional user metadata about the index template. It may have any contents. It is not automatically generated or used by Elasticsearch. This user-defined object is stored in the cluster state, so keeping it short is preferable To unset the metadata, replace the template without specifying it.' allOf: - $ref: '#/components/schemas/_types.Metadata' allow_auto_create: description: 'This setting overrides the value of the `action.auto_create_index` cluster setting. If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`. If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.' type: boolean ignore_missing_component_templates: description: 'The configuration option ignore_missing_component_templates can be used when an index template references a component template that might not exist' type: array items: type: string deprecated: description: 'Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning.' type: boolean examples: IndicesPutIndexTemplateRequestExample1: summary: Create a template value: "{\n \"index_patterns\" : [\"template*\"],\n \"priority\" : 1,\n \"template\": {\n \"settings\" : {\n \"number_of_shards\" : 2\n }\n }\n}" IndicesPutIndexTemplateRequestExample2: summary: Create a template with aliases description: 'You can include index aliases in an index template. During index creation, the `{index}` placeholder in the alias name will be replaced with the actual index name that the template gets applied to. ' value: "{\n \"index_patterns\": [\n \"template*\"\n ],\n \"template\": {\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"aliases\": {\n \"alias1\": {},\n \"alias2\": {\n \"filter\": {\n \"term\": {\n \"user.id\": \"kimchy\"\n }\n },\n \"routing\": \"shard-1\"\n },\n \"{index}-alias\": {}\n }\n }\n}" required: true indices.rollover: content: application/json: schema: type: object properties: aliases: description: 'Aliases for the target index. Data streams do not support this parameter.' type: object additionalProperties: $ref: '#/components/schemas/indices._types.Alias' conditions: description: 'Conditions for the rollover. If specified, Elasticsearch only performs the rollover if the current index satisfies these conditions. If this parameter is not specified, Elasticsearch performs the rollover unconditionally. If conditions are specified, at least one of them must be a `max_*` condition. The index will rollover if any `max_*` condition is satisfied and all `min_*` conditions are satisfied.' allOf: - $ref: '#/components/schemas/indices.rollover.RolloverConditions' mappings: description: 'Mapping for fields in the index. If specified, this mapping can include field names, field data types, and mapping paramaters.' allOf: - $ref: '#/components/schemas/_types.mapping.TypeMapping' settings: description: 'Configuration options for the index. Data streams do not support this parameter.' type: object additionalProperties: type: object examples: indicesRolloverRequestExample1: summary: Stack request description: Create a new index for a data stream value: "{\n \"conditions\": {\n \"max_age\": \"7d\",\n \"max_docs\": 1000,\n \"max_primary_shard_size\": \"50gb\",\n \"max_primary_shard_docs\": \"2000\"\n }\n}" indices.put_mapping: content: application/json: schema: type: object properties: date_detection: description: Controls whether dynamic date detection is enabled. type: boolean dynamic: description: Controls whether new fields are added dynamically. allOf: - $ref: '#/components/schemas/_types.mapping.DynamicMapping' dynamic_date_formats: description: 'If date detection is enabled then new string fields are checked against ''dynamic_date_formats'' and if the value matches then a new date field is added instead of string.' type: array items: type: string dynamic_templates: description: Specify dynamic templates for the mapping. type: array items: type: object additionalProperties: $ref: '#/components/schemas/_types.mapping.DynamicTemplate' minProperties: 1 maxProperties: 1 _field_names: description: Control whether field names are enabled for the index. allOf: - $ref: '#/components/schemas/_types.mapping.FieldNamesField' _meta: description: 'A mapping type can have custom meta data associated with it. These are not used at all by Elasticsearch, but can be used to store application-specific metadata.' allOf: - $ref: '#/components/schemas/_types.Metadata' numeric_detection: description: Automatically map strings into numeric data types for all fields. default: false type: boolean properties: description: 'Mapping for a field. For new fields, this mapping can include: - Field name - Field data type - Mapping parameters' type: object additionalProperties: $ref: '#/components/schemas/_types.mapping.Property' _routing: description: Enable making a routing value required on indexed documents. allOf: - $ref: '#/components/schemas/_types.mapping.RoutingField' _source: description: Control whether the _source field is enabled on the index. allOf: - $ref: '#/components/schemas/_types.mapping.SourceField' runtime: description: Mapping of runtime fields for the index. allOf: - $ref: '#/components/schemas/_types.mapping.RuntimeFields' examples: indicesPutMappingRequestExample1: summary: Update multiple targets description: 'The update mapping API can be applied to multiple data streams or indices with a single request. For example, run `PUT /my-index-000001,my-index-000002/_mapping` to update mappings for the `my-index-000001` and `my-index-000002` indices at the same time. ' value: "{\n \"properties\": {\n \"user\": {\n \"properties\": {\n \"name\": {\n \"type\": \"keyword\"\n }\n }\n }\n }\n}" required: true indices.put_alias: content: application/json: schema: type: object properties: filter: description: Query used to limit documents the alias can access. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' index_routing: description: 'Value used to route indexing operations to a specific shard. If specified, this overwrites the `routing` value for indexing operations. Data stream aliases don’t support this parameter.' type: string is_write_index: description: 'If `true`, sets the write index or data stream for the alias. If an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests. If an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index. Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream.' type: boolean routing: description: 'Value used to route indexing and search operations to a specific shard. Data stream aliases don’t support this parameter.' type: string search_routing: description: 'Value used to route search operations to a specific shard. If specified, this overwrites the `routing` value for search operations. Data stream aliases don’t support this parameter.' type: string examples: indicesPutAliasRequestExample1: summary: Filter an alias description: The filter option uses Query DSL to limit the documents an alias can access. value: "{\n \"filter\": {\n \"bool\": {\n \"filter\": [\n {\n \"range\": {\n \"@timestamp\": {\n \"gte\": \"now-1d/d\",\n \"lt\": \"now/d\"\n }\n }\n },\n {\n \"term\": {\n \"user.id\": \"kimchy\"\n }\n }\n ]\n }\n }\n}" indicesPutAliasRequestExample2: summary: Write index description: You can use is_write_index to specify a write index or data stream for an alias. Elasticsearch routes any write requests for the alias to this index or data stream. value: "{\n \"is_write_index\": true\n}" indicesPutAliasRequestExample3: summary: Routing description: Use the routing option to route requests for an alias to a specific shard. value: "{\n \"routing\": \"1\"\n}" indices.validate_query: content: application/json: schema: type: object properties: query: description: Query in the Lucene query string syntax. allOf: - $ref: '#/components/schemas/_types.query_dsl.QueryContainer' indices.split: content: application/json: schema: type: object properties: aliases: description: Aliases for the resulting index. type: object additionalProperties: $ref: '#/components/schemas/indices._types.Alias' settings: description: Configuration options for the target index. type: object additionalProperties: type: object examples: indicesSplitRequestExample1: description: Split an existing index into a new index with more primary shards. value: "{\n \"settings\": {\n \"index.number_of_shards\": 2\n }\n}" required: true indices.resolve_index: content: application/json: schema: type: object cluster.put_component_template: content: application/json: schema: type: object properties: template: description: The template to be applied which includes mappings, settings, or aliases configuration. allOf: - $ref: '#/components/schemas/indices.put_index_template.IndexTemplateMapping' version: description: 'Version number used to manage component templates externally. This number isn''t automatically generated or incremented by Elasticsearch. To unset a version, replace the template without specifying a version.' allOf: - $ref: '#/components/schemas/_types.VersionNumber' _meta: description: 'Optional user metadata about the component template. It may have any contents. This map is not automatically generated by Elasticsearch. This information is stored in the cluster state, so keeping it short is preferable. To unset `_meta`, replace the template without specifying this information.' allOf: - $ref: '#/components/schemas/_types.Metadata' deprecated: description: 'Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning.' type: boolean required: - template examples: ClusterPutComponentTemplateRequestExample1: summary: Create a template value: "{\n \"template\": {\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"mappings\": {\n \"_source\": {\n \"enabled\": false\n },\n \"properties\": {\n \"host_name\": {\n \"type\": \"keyword\"\n },\n \"created_at\": {\n \"type\": \"date\",\n \"format\": \"EEE MMM dd HH:mm:ss Z yyyy\"\n }\n }\n }\n }\n}" ClusterPutComponentTemplateRequestExample2: summary: Create a template with aliases description: 'You can include index aliases in a component template. During index creation, the `{index}` placeholder in the alias name will be replaced with the actual index name that the template gets applied to. ' value: "{\n \"template\": {\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"aliases\": {\n \"alias1\": {},\n \"alias2\": {\n \"filter\": {\n \"term\": {\n \"user.id\": \"kimchy\"\n }\n },\n \"routing\": \"shard-1\"\n },\n \"{index}-alias\": {}\n }\n }\n}" required: true indices.put_template: content: application/json: schema: type: object properties: aliases: description: Aliases for the index. type: object additionalProperties: $ref: '#/components/schemas/indices._types.Alias' index_patterns: description: 'Array of wildcard expressions used to match the names of indices during creation.' oneOf: - type: string - type: array items: type: string mappings: description: Mapping for fields in the index. allOf: - $ref: '#/components/schemas/_types.mapping.TypeMapping' order: description: 'Order in which Elasticsearch applies this template if index matches multiple templates. Templates with lower ''order'' values are merged first. Templates with higher ''order'' values are merged later, overriding templates with lower values.' type: number settings: description: Configuration options for the index. allOf: - $ref: '#/components/schemas/indices._types.IndexSettings' version: description: 'Version number used to manage index templates externally. This number is not automatically generated by Elasticsearch. To unset a version, replace the template without specifying one.' allOf: - $ref: '#/components/schemas/_types.VersionNumber' examples: indicesPutTemplateRequestExample1: summary: Create an index template value: "{\n \"index_patterns\": [\n \"te*\",\n \"bar*\"\n ],\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"mappings\": {\n \"_source\": {\n \"enabled\": false\n },\n \"properties\": {\n \"host_name\": {\n \"type\": \"keyword\"\n },\n \"created_at\": {\n \"type\": \"date\",\n \"format\": \"EEE MMM dd HH:mm:ss Z yyyy\"\n }\n }\n }\n}" indicesPutTemplateRequestExample2: summary: Create an index template with aliases description: 'You can include index aliases in an index template. During index creation, the `{index}` placeholder in the alias name will be replaced with the actual index name that the template gets applied to. ' value: "{\n \"index_patterns\": [\n \"te*\"\n ],\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"aliases\": {\n \"alias1\": {},\n \"alias2\": {\n \"filter\": {\n \"term\": {\n \"user.id\": \"kimchy\"\n }\n },\n \"routing\": \"shard-1\"\n },\n \"{index}-alias\": {}\n }\n}" required: true indices.clone: content: application/json: schema: type: object properties: aliases: description: Aliases for the resulting index. type: object additionalProperties: $ref: '#/components/schemas/indices._types.Alias' settings: description: Configuration options for the target index. type: object additionalProperties: type: object examples: indicesCloneRequestExample1: summary: Clone an existing index. description: 'Clone `my_source_index` into a new index called `my_target_index` with `POST /my_source_index/_clone/my_target_index`. The API accepts `settings` and `aliases` parameters for the target index. ' value: "{\n \"settings\": {\n \"index.refresh_interval\": \"2s\"\n },\n \"aliases\": {\n \"my_search_indices\": {}\n }\n}" indices.analyze: content: application/json: schema: type: object properties: analyzer: description: 'The name of the analyzer that should be applied to the provided `text`. This could be a built-in analyzer, or an analyzer that’s been configured in the index.' type: string attributes: description: Array of token attributes used to filter the output of the `explain` parameter. type: array items: type: string char_filter: description: Array of character filters used to preprocess characters before the tokenizer. type: array items: $ref: '#/components/schemas/_types.analysis.CharFilter' explain: description: If `true`, the response includes token attributes and additional details. default: false type: boolean field: description: 'Field used to derive the analyzer. To use this parameter, you must specify an index. If specified, the `analyzer` parameter overrides this value.' allOf: - $ref: '#/components/schemas/_types.Field' filter: description: Array of token filters used to apply after the tokenizer. type: array items: $ref: '#/components/schemas/_types.analysis.TokenFilter' normalizer: description: Normalizer to use to convert text into a single token. type: string text: description: 'Text to analyze. If an array of strings is provided, it is analyzed as a multi-value field.' allOf: - $ref: '#/components/schemas/indices.analyze.TextToAnalyze' tokenizer: description: Tokenizer to use to convert text into tokens. allOf: - $ref: '#/components/schemas/_types.analysis.Tokenizer' examples: indicesAnalyzeRequestExample1: summary: No index specified description: You can apply any of the built-in analyzers to the text string without specifying an index. value: "{\n \"analyzer\": \"standard\",\n \"text\": \"this is a test\"\n}" indicesAnalyzeRequestExample2: summary: An array of text strings description: If the text parameter is provided as array of strings, it is analyzed as a multi-value field. value: "{\n \"analyzer\": \"standard\",\n \"text\": [\n \"this is a test\",\n \"the second text\"\n ]\n}" indicesAnalyzeRequestExample3: summary: Custom analyzer example 1 description: You can test a custom transient analyzer built from tokenizers, token filters, and char filters. Token filters use the filter parameter. value: "{\n \"tokenizer\": \"keyword\",\n \"filter\": [\n \"lowercase\"\n ],\n \"char_filter\": [\n \"html_strip\"\n ],\n \"text\": \"this is a test\"\n}" indicesAnalyzeRequestExample4: summary: Custom analyzer example 2 description: Custom tokenizers, token filters, and character filters can be specified in the request body. value: "{\n \"tokenizer\": \"whitespace\",\n \"filter\": [\n \"lowercase\",\n {\n \"type\": \"stop\",\n \"stopwords\": [\n \"a\",\n \"is\",\n \"this\"\n ]\n }\n ],\n \"text\": \"this is a test\"\n}" indicesAnalyzeRequestExample5: summary: Derive analyzer from field mapping description: Run `GET /analyze_sample/_analyze` to run an analysis on the text using the default index analyzer associated with the `analyze_sample` index. Alternatively, the analyzer can be derived based on a field mapping. value: "{\n \"field\": \"obj1.field1\",\n \"text\": \"this is a test\"\n}" indicesAnalyzeRequestExample6: summary: Normalizer description: Run `GET /analyze_sample/_analyze` and supply a normalizer for a keyword field if there is a normalizer associated with the specified index. value: "{\n \"normalizer\": \"my_normalizer\",\n \"text\": \"BaR\"\n}" indicesAnalyzeRequestExample7: summary: Explain analysis description: 'If you want to get more advanced details, set `explain` to `true`. It will output all token attributes for each token. You can filter token attributes you want to output by setting the `attributes` option. NOTE: The format of the additional detail information is labelled as experimental in Lucene and it may change in the future. ' value: "{\n \"tokenizer\": \"standard\",\n \"filter\": [\n \"snowball\"\n ],\n \"text\": \"detailed output\",\n \"explain\": true,\n \"attributes\": [\n \"keyword\"\n ]\n}" required: true indices.simulate_template: content: application/json: schema: type: object properties: allow_auto_create: description: 'This setting overrides the value of the `action.auto_create_index` cluster setting. If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`. If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.' type: boolean index_patterns: description: Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation. allOf: - $ref: '#/components/schemas/_types.Indices' composed_of: description: 'An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.' type: array items: $ref: '#/components/schemas/_types.Name' template: description: 'Template to be applied. It may optionally include an `aliases`, `mappings`, or `settings` configuration.' allOf: - $ref: '#/components/schemas/indices.put_index_template.IndexTemplateMapping' data_stream: description: 'If this object is included, the template is used to create data streams and their backing indices. Supports an empty object. Data streams require a matching index template with a `data_stream` object.' allOf: - $ref: '#/components/schemas/indices._types.DataStreamVisibility' priority: description: 'Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by Elasticsearch.' type: number version: description: 'Version number used to manage index templates externally. This number is not automatically generated by Elasticsearch.' allOf: - $ref: '#/components/schemas/_types.VersionNumber' _meta: description: 'Optional user metadata about the index template. May have any contents. This map is not automatically generated by Elasticsearch.' allOf: - $ref: '#/components/schemas/_types.Metadata' ignore_missing_component_templates: description: 'The configuration option ignore_missing_component_templates can be used when an index template references a component template that might not exist' type: array items: type: string deprecated: description: 'Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning.' type: boolean examples: indicesSimulateTemplateRequestExample1: description: 'To see what settings will be applied by a template before you add it to the cluster, you can pass a template configuration in the request body. The specified template is used for the simulation if it has a higher priority than existing templates. ' value: "{\n \"index_patterns\": [\"my-index-*\"],\n \"composed_of\": [\"ct2\"],\n \"priority\": 10,\n \"template\": {\n \"settings\": {\n \"index.number_of_replicas\": 1\n }\n }\n}" indices.shrink: content: application/json: schema: type: object properties: aliases: description: 'The key is the alias name. Index alias names support date math.' type: object additionalProperties: $ref: '#/components/schemas/indices._types.Alias' settings: description: Configuration options for the target index. type: object additionalProperties: type: object examples: indicesShrinkRequestExample1: summary: Shrink an existing index into a new index with fewer primary shards. value: "{\n \"settings\": {\n \"index.routing.allocation.require._name\": null,\n \"index.blocks.write\": null\n }\n}" required: true indices.put_settings: content: application/json: schema: $ref: '#/components/schemas/indices._types.IndexSettings' examples: IndicesPutSettingsRequestExample1: summary: Change a dynamic index setting value: "{\n \"index\" : {\n \"number_of_replicas\" : 2\n }\n}" indicesPutSettingsRequestExample2: summary: Reset an index setting description: To revert a setting to the default value, use `null`. value: "{\n \"index\" : {\n \"refresh_interval\" : null\n }\n}" indicesPutSettingsRequestExample3: summary: Update index analysis description: To add an analyzer, you must close the index (`POST /my-index-000001/_close`), define the analyzer, then reopen the index (`POST /my-index-000001/_open`). value: "{\n \"analysis\": {\n \"analyzer\": {\n \"content\": {\n \"type\": \"custom\",\n \"tokenizer\": \"whitespace\"\n }\n }\n }\n}" required: true