Files
elasticsearch-js/docs/reference/api/IndicesPutSettingsRequest.md
2025-05-27 15:30:21 -05:00

2.5 KiB

Interface IndicesPutSettingsRequest

Name Type Description
allow_no_indices boolean If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.
body string ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; flat_settings?: never; ignore_unavailable?: never; master_timeout?: never; preserve_existing?: never; reopen?: never; timeout?: never; settings?: never; })
expand_wildcards ExpandWildcards 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.
flat_settings boolean If true, returns settings in flat format.
ignore_unavailable boolean If true, returns settings in flat format.
index Indices 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.
master_timeout Duration Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
preserve_existing boolean If true, existing index settings remain unchanged.
querystring { [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; flat_settings?: never; ignore_unavailable?: never; master_timeout?: never; preserve_existing?: never; reopen?: never; timeout?: never; settings?: never; } All values in querystring will be added to the request querystring.
reopen boolean 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.
settings IndicesIndexSettings  
timeout Duration Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.