Update security index settings | Elasticsearch API documentation (original) (raw)

Dismiss highlight Show more

Query parameters

• The 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.
• The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

application/json

Body Required

• Hide security attribute Show security attribute object
  • Hide index attributes Show index attributes object
    * Hide soft_deletes attributes Show soft_deletes attributes object
    * Indicates whether soft deletes are enabled on the index.
    * Hide retention_lease attribute Show retention_lease attribute object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Hide sort attributes Show sort attributes object
    * field
    string | array[string]
    * #### order string | array[string]
    Supported values include: asc (or ASC), desc (or DESC)
    Values are asc, ASC, desc, or DESC.
    Values are asc, ASC, desc, or DESC.
    * #### mode string | array[string]
    Supported values include: min (or MIN), max (or MAX)
    Values are min, MIN, max, or MAX.
    Values are min, MIN, max, or MAX.
    * #### missing string | array[string]
    Supported values include: _last, _first
    Values are _last or _first.
    Values are _last or _first.
    * Values are true, false, or checksum.
    * #### routing_partition_size number | string
    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.
    * #### auto_expand_replicas string | null
    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.
    * Hide merge attribute Show merge attribute object
    * Hide scheduler attributes Show scheduler attributes object
    * #### max_thread_count number | string
    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.
    * #### max_merge_count number | string
    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.
    * Hide search attributes Show search attributes object
    * Hide idle attribute Show idle attribute object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Hide slowlog attributes Show slowlog attributes object
    * Hide threshold attributes Show threshold attributes object
    * Hide query attributes Show query attributes object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Hide fetch attributes Show fetch attributes object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Hide blocks attributes Show blocks attributes object
    * #### read_only boolean | string
    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.
    * #### read_only_allow_delete boolean | string
    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.
    * #### read boolean | string
    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.
    * #### write boolean | string
    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.
    * #### metadata boolean | string
    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.
    * Hide analyze attribute Show analyze attribute object
    * #### max_token_count number | string
    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.
    * Hide highlight attribute Show highlight attribute object
    * Hide routing attributes Show routing attributes object
    * Hide allocation attributes Show allocation attributes object
    * Values are all, primaries, new_primaries, or none.
    * Hide include attributes Show include attributes object
    * Hide initial_recovery attribute Show initial_recovery attribute object
    * Hide disk attribute Show disk attribute object
    * Hide rebalance attribute Show rebalance attribute object
    * Values are all, primaries, replicas, or none.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Hide lifecycle attributes Show lifecycle attributes object
    * #### indexing_complete boolean | string
    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.
    * 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.
    * 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.
    * Hide step attribute Show step attribute object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * 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.
    * #### prefer_ilm boolean | string
    Preference for the system that manages a data stream backing index (preferring ILM when both ILM and DLM are applicable for an index).
    * #### creation_date number | string
    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.
    Time unit for milliseconds
    * #### creation_date_string string | number
    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.
    Time unit for milliseconds
    * Hide version attributes Show version attributes object
    * Hide translog attributes Show translog attributes object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Values are request, REQUEST, async, or ASYNC.
    * Hide retention attributes Show retention attributes object
    * #### size number | string
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Hide query_string attribute Show query_string attribute object
    * #### lenient boolean | string Required
    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.
    * Hide analysis attributes Show analysis attributes object
    * Hide time_series attributes Show time_series attributes object
    * #### end_time string | number
    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.
    Time unit for milliseconds
    * #### start_time string | number
    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.
    Time unit for milliseconds
    * Hide queries attribute Show queries attribute object
    * Hide cache attribute Show cache attribute object
    * Configure custom similarity settings to customize how search results are scored.
    * Hide mapping attributes Show mapping attributes object
    * Hide total_fields attributes Show total_fields attributes object
    * #### limit number | string
    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.
    * #### ignore_dynamic_beyond_limit boolean | string
    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.
    * Hide depth attribute Show depth attribute object
    * 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.
    * Hide nested_fields attribute Show nested_fields attribute object
    * 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.
    * Hide nested_objects attribute Show nested_objects attribute object
    * 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.
    * Hide field_name_length attribute Show field_name_length attribute object
    * 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).
    * Hide dimension_fields attribute Show dimension_fields attribute object
    * [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.
    * Hide source attribute Show source attribute object
    * Values are disabled, stored, or synthetic.
    * Hide indexing.slowlog attributes Show indexing.slowlog attributes object
    * Hide threshold attribute Show threshold attribute object
    * Hide index attributes Show index attributes object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Hide indexing_pressure attribute Show indexing_pressure attribute object
    * Hide memory attribute Show memory attribute object
    * 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.
    * Hide store attributes Show store attributes object
    * #### type string Required
    Values are fs, niofs, mmapfs, or hybridfs.
    * 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.
• Hide security-profile attribute Show security-profile attribute object
  • Hide index attributes Show index attributes object
    * Hide soft_deletes attributes Show soft_deletes attributes object
    * Indicates whether soft deletes are enabled on the index.
    * Hide retention_lease attribute Show retention_lease attribute object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Hide sort attributes Show sort attributes object
    * field
    string | array[string]
    * #### order string | array[string]
    Supported values include: asc (or ASC), desc (or DESC)
    Values are asc, ASC, desc, or DESC.
    Values are asc, ASC, desc, or DESC.
    * #### mode string | array[string]
    Supported values include: min (or MIN), max (or MAX)
    Values are min, MIN, max, or MAX.
    Values are min, MIN, max, or MAX.
    * #### missing string | array[string]
    Supported values include: _last, _first
    Values are _last or _first.
    Values are _last or _first.
    * Values are true, false, or checksum.
    * #### routing_partition_size number | string
    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.
    * #### auto_expand_replicas string | null
    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.
    * Hide merge attribute Show merge attribute object
    * Hide scheduler attributes Show scheduler attributes object
    * #### max_thread_count number | string
    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.
    * #### max_merge_count number | string
    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.
    * Hide search attributes Show search attributes object
    * Hide idle attribute Show idle attribute object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Hide slowlog attributes Show slowlog attributes object
    * Hide threshold attributes Show threshold attributes object
    * Hide query attributes Show query attributes object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Hide fetch attributes Show fetch attributes object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Hide blocks attributes Show blocks attributes object
    * #### read_only boolean | string
    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.
    * #### read_only_allow_delete boolean | string
    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.
    * #### read boolean | string
    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.
    * #### write boolean | string
    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.
    * #### metadata boolean | string
    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.
    * Hide analyze attribute Show analyze attribute object
    * #### max_token_count number | string
    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.
    * Hide highlight attribute Show highlight attribute object
    * Hide routing attributes Show routing attributes object
    * Hide allocation attributes Show allocation attributes object
    * Values are all, primaries, new_primaries, or none.
    * Hide include attributes Show include attributes object
    * Hide initial_recovery attribute Show initial_recovery attribute object
    * Hide disk attribute Show disk attribute object
    * Hide rebalance attribute Show rebalance attribute object
    * Values are all, primaries, replicas, or none.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Hide lifecycle attributes Show lifecycle attributes object
    * #### indexing_complete boolean | string
    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.
    * 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.
    * 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.
    * Hide step attribute Show step attribute object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * 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.
    * #### prefer_ilm boolean | string
    Preference for the system that manages a data stream backing index (preferring ILM when both ILM and DLM are applicable for an index).
    * #### creation_date number | string
    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.
    Time unit for milliseconds
    * #### creation_date_string string | number
    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.
    Time unit for milliseconds
    * Hide version attributes Show version attributes object
    * Hide translog attributes Show translog attributes object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Values are request, REQUEST, async, or ASYNC.
    * Hide retention attributes Show retention attributes object
    * #### size number | string
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Hide query_string attribute Show query_string attribute object
    * #### lenient boolean | string Required
    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.
    * Hide analysis attributes Show analysis attributes object
    * Hide time_series attributes Show time_series attributes object
    * #### end_time string | number
    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.
    Time unit for milliseconds
    * #### start_time string | number
    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.
    Time unit for milliseconds
    * Hide queries attribute Show queries attribute object
    * Hide cache attribute Show cache attribute object
    * Configure custom similarity settings to customize how search results are scored.
    * Hide mapping attributes Show mapping attributes object
    * Hide total_fields attributes Show total_fields attributes object
    * #### limit number | string
    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.
    * #### ignore_dynamic_beyond_limit boolean | string
    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.
    * Hide depth attribute Show depth attribute object
    * 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.
    * Hide nested_fields attribute Show nested_fields attribute object
    * 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.
    * Hide nested_objects attribute Show nested_objects attribute object
    * 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.
    * Hide field_name_length attribute Show field_name_length attribute object
    * 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).
    * Hide dimension_fields attribute Show dimension_fields attribute object
    * [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.
    * Hide source attribute Show source attribute object
    * Values are disabled, stored, or synthetic.
    * Hide indexing.slowlog attributes Show indexing.slowlog attributes object
    * Hide threshold attribute Show threshold attribute object
    * Hide index attributes Show index attributes object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Hide indexing_pressure attribute Show indexing_pressure attribute object
    * Hide memory attribute Show memory attribute object
    * 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.
    * Hide store attributes Show store attributes object
    * #### type string Required
    Values are fs, niofs, mmapfs, or hybridfs.
    * 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.
• Hide security-tokens attribute Show security-tokens attribute object
  • Hide index attributes Show index attributes object
    * Hide soft_deletes attributes Show soft_deletes attributes object
    * Indicates whether soft deletes are enabled on the index.
    * Hide retention_lease attribute Show retention_lease attribute object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Hide sort attributes Show sort attributes object
    * field
    string | array[string]
    * #### order string | array[string]
    Supported values include: asc (or ASC), desc (or DESC)
    Values are asc, ASC, desc, or DESC.
    Values are asc, ASC, desc, or DESC.
    * #### mode string | array[string]
    Supported values include: min (or MIN), max (or MAX)
    Values are min, MIN, max, or MAX.
    Values are min, MIN, max, or MAX.
    * #### missing string | array[string]
    Supported values include: _last, _first
    Values are _last or _first.
    Values are _last or _first.
    * Values are true, false, or checksum.
    * #### routing_partition_size number | string
    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.
    * #### auto_expand_replicas string | null
    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.
    * Hide merge attribute Show merge attribute object
    * Hide scheduler attributes Show scheduler attributes object
    * #### max_thread_count number | string
    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.
    * #### max_merge_count number | string
    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.
    * Hide search attributes Show search attributes object
    * Hide idle attribute Show idle attribute object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Hide slowlog attributes Show slowlog attributes object
    * Hide threshold attributes Show threshold attributes object
    * Hide query attributes Show query attributes object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Hide fetch attributes Show fetch attributes object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Hide blocks attributes Show blocks attributes object
    * #### read_only boolean | string
    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.
    * #### read_only_allow_delete boolean | string
    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.
    * #### read boolean | string
    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.
    * #### write boolean | string
    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.
    * #### metadata boolean | string
    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.
    * Hide analyze attribute Show analyze attribute object
    * #### max_token_count number | string
    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.
    * Hide highlight attribute Show highlight attribute object
    * Hide routing attributes Show routing attributes object
    * Hide allocation attributes Show allocation attributes object
    * Values are all, primaries, new_primaries, or none.
    * Hide include attributes Show include attributes object
    * Hide initial_recovery attribute Show initial_recovery attribute object
    * Hide disk attribute Show disk attribute object
    * Hide rebalance attribute Show rebalance attribute object
    * Values are all, primaries, replicas, or none.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Hide lifecycle attributes Show lifecycle attributes object
    * #### indexing_complete boolean | string
    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.
    * 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.
    * 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.
    * Hide step attribute Show step attribute object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * 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.
    * #### prefer_ilm boolean | string
    Preference for the system that manages a data stream backing index (preferring ILM when both ILM and DLM are applicable for an index).
    * #### creation_date number | string
    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.
    Time unit for milliseconds
    * #### creation_date_string string | number
    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.
    Time unit for milliseconds
    * Hide version attributes Show version attributes object
    * Hide translog attributes Show translog attributes object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Values are request, REQUEST, async, or ASYNC.
    * Hide retention attributes Show retention attributes object
    * #### size number | string
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Hide query_string attribute Show query_string attribute object
    * #### lenient boolean | string Required
    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.
    * Hide analysis attributes Show analysis attributes object
    * Hide time_series attributes Show time_series attributes object
    * #### end_time string | number
    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.
    Time unit for milliseconds
    * #### start_time string | number
    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.
    Time unit for milliseconds
    * Hide queries attribute Show queries attribute object
    * Hide cache attribute Show cache attribute object
    * Configure custom similarity settings to customize how search results are scored.
    * Hide mapping attributes Show mapping attributes object
    * Hide total_fields attributes Show total_fields attributes object
    * #### limit number | string
    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.
    * #### ignore_dynamic_beyond_limit boolean | string
    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.
    * Hide depth attribute Show depth attribute object
    * 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.
    * Hide nested_fields attribute Show nested_fields attribute object
    * 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.
    * Hide nested_objects attribute Show nested_objects attribute object
    * 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.
    * Hide field_name_length attribute Show field_name_length attribute object
    * 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).
    * Hide dimension_fields attribute Show dimension_fields attribute object
    * [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.
    * Hide source attribute Show source attribute object
    * Values are disabled, stored, or synthetic.
    * Hide indexing.slowlog attributes Show indexing.slowlog attributes object
    * Hide threshold attribute Show threshold attribute object
    * Hide index attributes Show index attributes object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Hide indexing_pressure attribute Show indexing_pressure attribute object
    * Hide memory attribute Show memory attribute object
    * 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.
    * Hide store attributes Show store attributes object
    * #### type string Required
    Values are fs, niofs, mmapfs, or hybridfs.
    * 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.

Responses

• 200 application/json
  Hide response attribute Show response attribute object