Path parameters

• index string | array[string] Required

  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.

• name string | array[string] Required

  Comma-separated list or wildcard expression of settings to retrieve.

Query parameters

• 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.

• expand_wildcards string | array[string]

  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 false, the request returns an error if it targets a missing or closed index.

• include_defaults boolean

  If true, return all default settings in the response.

• local boolean

  If true, the request retrieves information from the local node only. If false, information is retrieved from the master node.

• master_timeout string

  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.

Responses

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

  • * object

    Additional properties are allowed.

    Hide * attributes Show * attributes object

    • aliases object
      Hide aliases attribute Show aliases attribute object

      • * object Additional properties

        Additional properties are allowed.

        Hide * attributes Show * attributes object

        • filter object

          Additional properties are allowed.

          External documentation
        • index_routing string
        • is_hidden boolean

          If true, the alias is hidden. All indices for the alias must have the same is_hidden value.

        • is_write_index boolean

          If true, the index is the write index for the alias.

        • routing string
        • search_routing string
    • mappings object

      Additional properties are allowed.

      Hide mappings attributes Show mappings attributes object

      • all_field object

        Additional properties are allowed.

        Hide all_field attributes Show all_field attributes object

        • analyzer string Required
        • enabled boolean Required
        • omit_norms boolean Required
        • search_analyzer string Required
        • similarity string Required
        • store boolean Required
        • store_term_vector_offsets boolean Required
        • store_term_vector_payloads boolean Required
        • store_term_vector_positions boolean Required
        • store_term_vectors boolean Required
      • date_detection boolean
      • dynamic string

        Values are strict, runtime, true, or false.

      • dynamic_date_formats array[string]
      • dynamic_templates array[object]
      • _field_names object

        Additional properties are allowed.

        Hide _field_names attribute Show _field_names attribute object

        • enabled boolean Required
      • index_field object

        Additional properties are allowed.

        Hide index_field attribute Show index_field attribute object

        • enabled boolean Required
      • _meta object
        Hide _meta attribute Show _meta attribute object

        • * object Additional properties

          Additional properties are allowed.

      • numeric_detection boolean
      • properties object
      • _routing object

        Additional properties are allowed.

        Hide _routing attribute Show _routing attribute object

        • required boolean Required
      • _size object

        Additional properties are allowed.

        Hide _size attribute Show _size attribute object

        • enabled boolean Required
      • _source object

        Additional properties are allowed.

        Hide _source attributes Show _source attributes object

        • compress boolean
        • compress_threshold string
        • enabled boolean
        • excludes array[string]
        • includes array[string]
        • mode string

          Values are disabled, stored, or synthetic.

      • runtime object
        Hide runtime attribute Show runtime attribute object

        • * object Additional properties

          Additional properties are allowed.

          Hide * attributes Show * attributes object

          • fields object

            For type composite

            Hide fields attribute Show fields attribute object

            • * object Additional properties

              Additional properties are allowed.

          • fetch_fields array[object]

            For type lookup

            Additional properties are allowed.

          • format string

            A custom format for date type runtime fields.

          • input_field string

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • target_field string

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • target_index string
          • script object

            Additional properties are allowed.

            Hide script attributes Show script attributes object

            • source string

              The script source.

            • id string
            • params object

              Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.

            • lang
            • options object
          • type string Required

            Values are boolean, composite, date, double, geo_point, ip, keyword, long, or lookup.

      • enabled boolean
      • subobjects boolean
      • _data_stream_timestamp object

        Additional properties are allowed.

        Hide _data_stream_timestamp attribute Show _data_stream_timestamp attribute object

        • enabled boolean Required
    • settings object Additional properties

      Additional properties are allowed.

      Hide settings attributes Show settings attributes object

      • index object Additional properties

        Additional properties are allowed.

      • mode string

      • routing_path string | array[string]

        One of:

        string-1 string array-2 array[string]
      • soft_deletes object

        Additional properties are allowed.

        Hide soft_deletes attributes Show soft_deletes attributes object

        • enabled boolean

          Indicates whether soft deletes are enabled on the index.

        • retention_lease object

          Additional properties are allowed.

          Hide retention_lease attribute Show retention_lease attribute object

          • period string Required

            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.

      • sort object

        Additional properties are allowed.

        Hide sort attributes Show sort attributes object

        • field string | array[string]

        • order string | array[string]

          One of:

          _types:SegmentSortOrder string array-2 array[string]

          Values are asc, ASC, desc, or DESC.

          Values are asc, ASC, desc, or DESC.

        • mode string | array[string]

          One of:

          _types:SegmentSortMode string array-2 array[string]

          Values are min, MIN, max, or MAX.

          Values are min, MIN, max, or MAX.

        • missing string | array[string]

          One of:

          _types:SegmentSortMissing string array-2 array[string]

          Values are _last or _first.

          Values are _last or _first.

      • number_of_shards number | string

        One of:

        number-1 number string-2 string

      • number_of_replicas number | string

        One of:

        number-1 number string-2 string
      • number_of_routing_shards number
      • check_on_startup string

        Values are true, false, or checksum.

      • codec string

      • 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.

        One of:

        _spec_utils:Stringifiedinteger number _spec_utils:Stringifiedinteger string
      • load_fixed_bitset_filters_eagerly boolean

      • hidden boolean | string

        One of:

        boolean-1 boolean string-2 string
      • auto_expand_replicas string
      • merge object

        Additional properties are allowed.

        Hide merge attribute Show merge attribute object

        • scheduler object

          Additional properties are allowed.

          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.

            One of:

            _spec_utils:Stringifiedinteger number _spec_utils:Stringifiedinteger string

          • 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.

            One of:

            _spec_utils:Stringifiedinteger number _spec_utils:Stringifiedinteger string
      • search object

        Additional properties are allowed.

        Hide search attributes Show search attributes object

        • idle object

          Additional properties are allowed.

          Hide idle attribute Show idle attribute object

          • after string

            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.

        • slowlog object

          Additional properties are allowed.

          Hide slowlog attributes Show slowlog attributes object

          • level string
          • source number
          • reformat boolean
          • threshold object

            Additional properties are allowed.

            Hide threshold attributes Show threshold attributes object

            • query object

              Additional properties are allowed.

            • fetch object

              Additional properties are allowed.

      • refresh_interval string

        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.

      • max_result_window number
      • max_inner_result_window number
      • max_rescore_window number
      • max_docvalue_fields_search number
      • max_script_fields number
      • max_ngram_diff number
      • max_shingle_diff number
      • blocks object

        Additional properties are allowed.

        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.

          One of:

          _spec_utils:Stringifiedboolean boolean _spec_utils:Stringifiedboolean string

        • 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.

          One of:

          _spec_utils:Stringifiedboolean boolean _spec_utils:Stringifiedboolean string

        • 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.

          One of:

          _spec_utils:Stringifiedboolean boolean _spec_utils:Stringifiedboolean string

        • 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.

          One of:

          _spec_utils:Stringifiedboolean boolean _spec_utils:Stringifiedboolean string

        • 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.

          One of:

          _spec_utils:Stringifiedboolean boolean _spec_utils:Stringifiedboolean string
      • max_refresh_listeners number
      • analyze object

        Additional properties are allowed.

        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.

          One of:

          _spec_utils:Stringifiedinteger number _spec_utils:Stringifiedinteger string
      • highlight object

        Additional properties are allowed.

        Hide highlight attribute Show highlight attribute object

        • max_analyzed_offset number
      • max_terms_count number
      • max_regex_length number
      • routing object

        Additional properties are allowed.

        Hide routing attributes Show routing attributes object

        • allocation object

          Additional properties are allowed.

          Hide allocation attributes Show allocation attributes object

          • enable string

            Values are all, primaries, new_primaries, or none.

          • include object

            Additional properties are allowed.

            Hide include attributes Show include attributes object

            • _tier_preference string
            • _id string
          • initial_recovery object

            Additional properties are allowed.

            Hide initial_recovery attribute Show initial_recovery attribute object

            • _id string
          • disk object

            Additional properties are allowed.

            Hide disk attribute Show disk attribute object

            • threshold_enabled
        • rebalance object

          Additional properties are allowed.

          Hide rebalance attribute Show rebalance attribute object

          • enable string Required

            Values are all, primaries, replicas, or none.

      • gc_deletes string

        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.

      • default_pipeline string
      • final_pipeline string
      • lifecycle object

        Additional properties are allowed.

        Hide lifecycle attributes Show lifecycle attributes object

        • name string

        • 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.

          One of:

          _spec_utils:Stringifiedboolean boolean _spec_utils:Stringifiedboolean string
        • origination_date number

          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.

        • parse_origination_date boolean

          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.

        • step object

          Additional properties are allowed.

          Hide step attribute Show step attribute object

          • wait_time_threshold string

            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.

        • rollover_alias string

          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.

      • provided_name string

      • 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.

        One of:

        _types:UnitMillis number _spec_utils:StringifiedEpochTimeUnitMillis string

        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.

        One of:

        _types:DateTime string _types:UnitMillis number

        Time unit for milliseconds

      • uuid string
      • version object

        Additional properties are allowed.

        Hide version attributes Show version attributes object

        • created string
        • created_string string

      • verified_before_close boolean | string

        One of:

        boolean-1 boolean string-2 string

      • format string | number

        One of:

        string-1 string number-2 number
      • max_slices_per_scroll number
      • translog object

        Additional properties are allowed.

        Hide translog attributes Show translog attributes object

        • sync_interval string

          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.

        • durability string

          Values are request, REQUEST, async, or ASYNC.

        • flush_threshold_size number | string

          One of:

          _types:ByteSize number _types:ByteSize string
        • retention object

          Additional properties are allowed.

          Hide retention attributes Show retention attributes object

          • size number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • age string

            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.

      • query_string object

        Additional properties are allowed.

        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.

          One of:

          _spec_utils:Stringifiedboolean boolean _spec_utils:Stringifiedboolean string

      • priority number | string

        One of:

        number-1 number string-2 string
      • top_metrics_max_size number
      • analysis object

        Additional properties are allowed.

        Hide analysis attributes Show analysis attributes object

        • analyzer object
        • char_filter object
        • filter object
        • normalizer object
        • tokenizer object
      • settings object Additional properties

        Additional properties are allowed.

      • time_series object

        Additional properties are allowed.

        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.

          One of:

          _types:DateTime string _types:UnitMillis number

          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.

          One of:

          _types:DateTime string _types:UnitMillis number

          Time unit for milliseconds

      • queries object

        Additional properties are allowed.

        Hide queries attribute Show queries attribute object

        • cache object

          Additional properties are allowed.

          Hide cache attribute Show cache attribute object

          • enabled boolean Required
      • similarity object

        Configure custom similarity settings to customize how search results are scored.

      • mapping object

        Additional properties are allowed.

        Hide mapping attributes Show mapping attributes object

        • coerce boolean
        • total_fields object

          Additional properties are allowed.

          Hide total_fields attributes Show total_fields attributes object

          • limit number

            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

            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.

        • depth object

          Additional properties are allowed.

          Hide depth attribute Show depth attribute object

          • limit number

            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.

        • nested_fields object

          Additional properties are allowed.

          Hide nested_fields attribute Show nested_fields attribute object

          • limit number

            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.

        • nested_objects object

          Additional properties are allowed.

          Hide nested_objects attribute Show nested_objects attribute object

          • limit number

            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.

        • field_name_length object

          Additional properties are allowed.

          Hide field_name_length attribute Show field_name_length attribute object

          • limit number

            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).

        • dimension_fields object

          Additional properties are allowed.

          Hide dimension_fields attribute Show dimension_fields attribute object

          • limit number

            [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.

        • ignore_malformed boolean
      • indexing.slowlog object

        Additional properties are allowed.

        Hide indexing.slowlog attributes Show indexing.slowlog attributes object

        • level string
        • source number
        • reformat boolean
        • threshold object

          Additional properties are allowed.

          Hide threshold attribute Show threshold attribute object

          • index object

            Additional properties are allowed.

            Hide index attributes Show index attributes object

            • warn string

              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.

            • info string

              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.

            • debug string

              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.

            • trace string

              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.

      • indexing_pressure object

        Additional properties are allowed.

        Hide indexing_pressure attribute Show indexing_pressure attribute object

        • memory object Required

          Additional properties are allowed.

          Hide memory attribute Show memory attribute object

          • limit number

            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.

      • store object

        Additional properties are allowed.

        Hide store attributes Show store attributes object

        • type string Required

          Any of:

          _types:StorageType string _types:StorageType string

          Values are fs, niofs, mmapfs, or hybridfs.
        • allow_mmap boolean

          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.

    • defaults object Additional properties

      Additional properties are allowed.

      Hide defaults attributes Show defaults attributes object

      • index object Additional properties

        Additional properties are allowed.

      • mode string

      • routing_path string | array[string]

        One of:

        string-1 string array-2 array[string]
      • soft_deletes object

        Additional properties are allowed.

        Hide soft_deletes attributes Show soft_deletes attributes object

        • enabled boolean

          Indicates whether soft deletes are enabled on the index.

        • retention_lease object

          Additional properties are allowed.

          Hide retention_lease attribute Show retention_lease attribute object

          • period string Required

            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.

      • sort object

        Additional properties are allowed.

        Hide sort attributes Show sort attributes object

        • field string | array[string]

        • order string | array[string]

          One of:

          _types:SegmentSortOrder string array-2 array[string]

          Values are asc, ASC, desc, or DESC.

          Values are asc, ASC, desc, or DESC.

        • mode string | array[string]

          One of:

          _types:SegmentSortMode string array-2 array[string]

          Values are min, MIN, max, or MAX.

          Values are min, MIN, max, or MAX.

        • missing string | array[string]

          One of:

          _types:SegmentSortMissing string array-2 array[string]

          Values are _last or _first.

          Values are _last or _first.

      • number_of_shards number | string

        One of:

        number-1 number string-2 string

      • number_of_replicas number | string

        One of:

        number-1 number string-2 string
      • number_of_routing_shards number
      • check_on_startup string

        Values are true, false, or checksum.

      • codec string

      • 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.

        One of:

        _spec_utils:Stringifiedinteger number _spec_utils:Stringifiedinteger string
      • load_fixed_bitset_filters_eagerly boolean

      • hidden boolean | string

        One of:

        boolean-1 boolean string-2 string
      • auto_expand_replicas string
      • merge object

        Additional properties are allowed.

        Hide merge attribute Show merge attribute object

        • scheduler object

          Additional properties are allowed.

          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.

            One of:

            _spec_utils:Stringifiedinteger number _spec_utils:Stringifiedinteger string

          • 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.

            One of:

            _spec_utils:Stringifiedinteger number _spec_utils:Stringifiedinteger string
      • search object

        Additional properties are allowed.

        Hide search attributes Show search attributes object

        • idle object

          Additional properties are allowed.

          Hide idle attribute Show idle attribute object

          • after string

            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.

        • slowlog object

          Additional properties are allowed.

          Hide slowlog attributes Show slowlog attributes object

          • level string
          • source number
          • reformat boolean
          • threshold object

            Additional properties are allowed.

            Hide threshold attributes Show threshold attributes object

            • query object

              Additional properties are allowed.

            • fetch object

              Additional properties are allowed.

      • refresh_interval string

        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.

      • max_result_window number
      • max_inner_result_window number
      • max_rescore_window number
      • max_docvalue_fields_search number
      • max_script_fields number
      • max_ngram_diff number
      • max_shingle_diff number
      • blocks object

        Additional properties are allowed.

        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.

          One of:

          _spec_utils:Stringifiedboolean boolean _spec_utils:Stringifiedboolean string

        • 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.

          One of:

          _spec_utils:Stringifiedboolean boolean _spec_utils:Stringifiedboolean string

        • 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.

          One of:

          _spec_utils:Stringifiedboolean boolean _spec_utils:Stringifiedboolean string

        • 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.

          One of:

          _spec_utils:Stringifiedboolean boolean _spec_utils:Stringifiedboolean string

        • 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.

          One of:

          _spec_utils:Stringifiedboolean boolean _spec_utils:Stringifiedboolean string
      • max_refresh_listeners number
      • analyze object

        Additional properties are allowed.

        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.

          One of:

          _spec_utils:Stringifiedinteger number _spec_utils:Stringifiedinteger string
      • highlight object

        Additional properties are allowed.

        Hide highlight attribute Show highlight attribute object

        • max_analyzed_offset number
      • max_terms_count number
      • max_regex_length number
      • routing object

        Additional properties are allowed.

        Hide routing attributes Show routing attributes object

        • allocation object

          Additional properties are allowed.

          Hide allocation attributes Show allocation attributes object

          • enable string

            Values are all, primaries, new_primaries, or none.

          • include object

            Additional properties are allowed.

            Hide include attributes Show include attributes object

            • _tier_preference string
            • _id string
          • initial_recovery object

            Additional properties are allowed.

            Hide initial_recovery attribute Show initial_recovery attribute object

            • _id string
          • disk object

            Additional properties are allowed.

            Hide disk attribute Show disk attribute object

            • threshold_enabled
        • rebalance object

          Additional properties are allowed.

          Hide rebalance attribute Show rebalance attribute object

          • enable string Required

            Values are all, primaries, replicas, or none.

      • gc_deletes string

        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.

      • default_pipeline string
      • final_pipeline string
      • lifecycle object

        Additional properties are allowed.

        Hide lifecycle attributes Show lifecycle attributes object

        • name string

        • 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.

          One of:

          _spec_utils:Stringifiedboolean boolean _spec_utils:Stringifiedboolean string
        • origination_date number

          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.

        • parse_origination_date boolean

          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.

        • step object

          Additional properties are allowed.

          Hide step attribute Show step attribute object

          • wait_time_threshold string

            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.

        • rollover_alias string

          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.

      • provided_name string

      • 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.

        One of:

        _types:UnitMillis number _spec_utils:StringifiedEpochTimeUnitMillis string

        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.

        One of:

        _types:DateTime string _types:UnitMillis number

        Time unit for milliseconds

      • uuid string
      • version object

        Additional properties are allowed.

        Hide version attributes Show version attributes object

        • created string
        • created_string string

      • verified_before_close boolean | string

        One of:

        boolean-1 boolean string-2 string

      • format string | number

        One of:

        string-1 string number-2 number
      • max_slices_per_scroll number
      • translog object

        Additional properties are allowed.

        Hide translog attributes Show translog attributes object

        • sync_interval string

          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.

        • durability string

          Values are request, REQUEST, async, or ASYNC.

        • flush_threshold_size number | string

          One of:

          _types:ByteSize number _types:ByteSize string
        • retention object

          Additional properties are allowed.

          Hide retention attributes Show retention attributes object

          • size number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • age string

            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.

      • query_string object

        Additional properties are allowed.

        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.

          One of:

          _spec_utils:Stringifiedboolean boolean _spec_utils:Stringifiedboolean string

      • priority number | string

        One of:

        number-1 number string-2 string
      • top_metrics_max_size number
      • analysis object

        Additional properties are allowed.

        Hide analysis attributes Show analysis attributes object

        • analyzer object
        • char_filter object
        • filter object
        • normalizer object
        • tokenizer object
      • settings object Additional properties

        Additional properties are allowed.

      • time_series object

        Additional properties are allowed.

        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.

          One of:

          _types:DateTime string _types:UnitMillis number

          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.

          One of:

          _types:DateTime string _types:UnitMillis number

          Time unit for milliseconds

      • queries object

        Additional properties are allowed.

        Hide queries attribute Show queries attribute object

        • cache object

          Additional properties are allowed.

          Hide cache attribute Show cache attribute object

          • enabled boolean Required
      • similarity object

        Configure custom similarity settings to customize how search results are scored.

      • mapping object

        Additional properties are allowed.

        Hide mapping attributes Show mapping attributes object

        • coerce boolean
        • total_fields object

          Additional properties are allowed.

          Hide total_fields attributes Show total_fields attributes object

          • limit number

            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

            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.

        • depth object

          Additional properties are allowed.

          Hide depth attribute Show depth attribute object

          • limit number

            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.

        • nested_fields object

          Additional properties are allowed.

          Hide nested_fields attribute Show nested_fields attribute object

          • limit number

            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.

        • nested_objects object

          Additional properties are allowed.

          Hide nested_objects attribute Show nested_objects attribute object

          • limit number

            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.

        • field_name_length object

          Additional properties are allowed.

          Hide field_name_length attribute Show field_name_length attribute object

          • limit number

            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).

        • dimension_fields object

          Additional properties are allowed.

          Hide dimension_fields attribute Show dimension_fields attribute object

          • limit number

            [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.

        • ignore_malformed boolean
      • indexing.slowlog object

        Additional properties are allowed.

        Hide indexing.slowlog attributes Show indexing.slowlog attributes object

        • level string
        • source number
        • reformat boolean
        • threshold object

          Additional properties are allowed.

          Hide threshold attribute Show threshold attribute object

          • index object

            Additional properties are allowed.

            Hide index attributes Show index attributes object

            • warn string

              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.

            • info string

              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.

            • debug string

              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.

            • trace string

              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.

      • indexing_pressure object

        Additional properties are allowed.

        Hide indexing_pressure attribute Show indexing_pressure attribute object

        • memory object Required

          Additional properties are allowed.

          Hide memory attribute Show memory attribute object

          • limit number

            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.

      • store object

        Additional properties are allowed.

        Hide store attributes Show store attributes object

        • type string Required

          Any of:

          _types:StorageType string _types:StorageType string

          Values are fs, niofs, mmapfs, or hybridfs.
        • allow_mmap boolean

          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.

    • data_stream string
    • lifecycle object

      Additional properties are allowed.

      Hide lifecycle attributes Show lifecycle attributes object

      • data_retention string

        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.

      • downsampling object

        Additional properties are allowed.

        Hide downsampling attribute Show downsampling attribute object

        • rounds array[object] Required

          The list of downsampling rounds to execute as part of this downsampling configuration

          Hide rounds attributes Show rounds attributes object

          • after string Required

            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.

          • config object Required

            Additional properties are allowed.