17 lines
2.0 KiB
Markdown
17 lines
2.0 KiB
Markdown
# `IndicesPutTemplateRequest` [interface-IndicesPutTemplateRequest]
|
|
|
|
| Name | Type | Description |
|
|
| - | - | - |
|
|
| `aliases` | Record<[IndexName](./IndexName.md), [IndicesAlias](./IndicesAlias.md)> | Aliases for the index. |
|
|
| `body` | string | ({ [key: string]: any; } & { name?: never; create?: never; master_timeout?: never; cause?: never; aliases?: never; index_patterns?: never; mappings?: never; order?: never; settings?: never; version?: never; }) | All values in `body` will be added to the request body. |
|
|
| `cause` | string | User defined reason for creating/updating the index template |
|
|
| `create` | boolean | If true, this request cannot replace or update existing index templates. |
|
|
| `index_patterns` | string | string[] | Array of wildcard expressions used to match the names of indices during creation. |
|
|
| `mappings` | [MappingTypeMapping](./MappingTypeMapping.md) | Mapping for fields in the index. |
|
|
| `master_timeout` | [Duration](./Duration.md) | 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. |
|
|
| `name` | [Name](./Name.md) | The name of the template |
|
|
| `order` | [integer](./integer.md) | 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. |
|
|
| `querystring` | { [key: string]: any; } & { name?: never; create?: never; master_timeout?: never; cause?: never; aliases?: never; index_patterns?: never; mappings?: never; order?: never; settings?: never; version?: never; } | All values in `querystring` will be added to the request querystring. |
|
|
| `settings` | [IndicesIndexSettings](./IndicesIndexSettings.md) | Configuration options for the index. |
|
|
| `version` | [VersionNumber](./VersionNumber.md) | 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. |
|