Body Required

• mappings_override object
  Hide mappings_override attributes Show mappings_override attributes object

  • all_field object
    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
    Hide _field_names attribute Show _field_names attribute object

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

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

    • * object Additional properties
  • numeric_detection boolean
  • properties object
  • _routing object
    Hide _routing attribute Show _routing attribute object

    • required boolean Required
  • _size object
    Hide _size attribute Show _size attribute object

    • enabled boolean Required
  • _source object
    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
      Hide * attributes Show * attributes object

      • fields object

        For type composite

        Hide fields attribute Show fields attribute object

        • * object Additional properties
          Hide * attribute Show * attribute object

          • type string Required

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

      • fetch_fields array[object]

        For type lookup

        Hide fetch_fields attributes Show fetch_fields attributes object

        • field string Required

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

        • format string
      • 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
        Hide script attributes Show script attributes object

        • source string | object

          One of:

          ScriptSource string SearchRequestBody object

          Hide attributes Show attributes

          • aggregations object

            Defines the aggregations that are run as part of the search request.

          • collapse object
          • explain boolean

            If true, the request returns detailed information about score computation as part of a hit.

          • ext object

            Configuration of search extensions defined by Elasticsearch plugins.

          • from number

            The starting document offset, which must be non-negative. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.

          • highlight
          • track_total_hits boolean | number

            Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query. Defaults to 10,000 hits.

          • indices_boost array[object]

            Boost the _score of documents from specified indices. The boost value is the factor by which scores are multiplied. A boost value greater than 1.0 increases the score. A boost value between 0 and 1.0 decreases the score.

          • docvalue_fields array[object]

            An array of wildcard (*) field patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response.

          • knn
          • rank object
          • min_score number

            The minimum _score for matching documents. Documents with a lower _score are not included in search results or results collected by aggregations.

          • post_filter object

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

          • profile boolean

            Set to true to return detailed timing information about the execution of individual components in a search request. NOTE: This is a debugging tool and adds significant overhead to search execution.

          • query object

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

          • rescore
          • retriever object
          • script_fields object

            Retrieve a script evaluation (based on different fields) for each hit.

          • search_after array[number | string | boolean | null]

            A field value.

          • size number

            The number of hits to return, which must not be negative. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after property.

          • slice object
          • sort
          • _source
          • fields array[object]

            An array of wildcard (*) field patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.

          • suggest object
          • terminate_after number

            The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting.

            IMPORTANT: Use with caution. Elasticsearch applies this property to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this property for requests that target data streams with backing indices across multiple data tiers.

            If set to 0 (default), the query does not terminate early.

          • timeout string

            The period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.

          • track_scores boolean

            If true, calculate and return document scores, even if the scores are not used for sorting.

          • version boolean

            If true, the request returns the document version as part of a hit.

          • seq_no_primary_term boolean

            If true, the request returns sequence number and primary term of the last modification of each hit.

          • stored_fields string | array[string]
          • pit object
          • runtime_mappings object
          • stats array[string]

            The stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API.

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

          Hide params attribute Show params attribute object

          • * object Additional properties

        • lang string

          Any of:

          ScriptLanguage string ScriptLanguage string

          Values are painless, expression, mustache, or java.
        • options object
          Hide options attribute Show options attribute object

          • * string Additional properties
      • type string Required

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

  • enabled boolean
  • subobjects string

    Values are true or false.

  • _data_stream_timestamp object
    Hide _data_stream_timestamp attribute Show _data_stream_timestamp attribute object

    • enabled boolean Required
• settings_override object
  Hide settings_override attributes Show settings_override attributes object

  • index object
  • mode string

  • routing_path string | array[string]

    One of:

    string-1 string array-2 array[string]
  • soft_deletes object
    Hide soft_deletes attributes Show soft_deletes attributes object

    • enabled boolean

      Indicates whether soft deletes are enabled on the index.

    • retention_lease object
      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
    Hide sort attributes Show sort attributes object

    • field string | array[string]

    • order string | array[string]

      One of:

      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:

      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:

      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:

    Stringifiedinteger number Stringifiedinteger string
  • load_fixed_bitset_filters_eagerly boolean

  • hidden boolean | string

    One of:

    boolean-1 boolean string-2 string

  • auto_expand_replicas string | null

    One of:

    string-1 string NullValue 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.

  • merge object
    Hide merge attribute Show merge attribute object

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

        One of:

        Stringifiedinteger number 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:

        Stringifiedinteger number Stringifiedinteger string
  • search object
    Hide search attributes Show search attributes object

    • idle object
      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
      Hide slowlog attributes Show slowlog attributes object

      • level string
      • source number
      • reformat boolean
      • threshold object
        Hide threshold attributes Show threshold attributes object

        • query object
          Hide query attributes Show query 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.

        • fetch object
          Hide fetch attributes Show fetch 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.

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

      Stringifiedboolean boolean 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:

      Stringifiedboolean boolean 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:

      Stringifiedboolean boolean 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:

      Stringifiedboolean boolean 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:

      Stringifiedboolean boolean Stringifiedboolean string
  • max_refresh_listeners number
  • analyze object
    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:

      Stringifiedinteger number Stringifiedinteger string
  • highlight object
    Hide highlight attribute Show highlight attribute object

    • max_analyzed_offset number
  • max_terms_count number
  • max_regex_length number
  • routing object
    Hide routing attributes Show routing attributes object

    • allocation object
      Hide allocation attributes Show allocation attributes object

      • enable string

        Values are all, primaries, new_primaries, or none.

      • include object
        Hide include attributes Show include attributes object

        • _tier_preference string
        • _id string
      • initial_recovery object
        Hide initial_recovery attribute Show initial_recovery attribute object

        • _id string
      • disk object
        Hide disk attribute Show disk attribute object

        • threshold_enabled boolean | string

          One of:

          boolean-1 boolean string-2 string
    • rebalance object
      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
    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:

      Stringifiedboolean boolean 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
      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.

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

      One of:

      boolean-1 boolean string-2 string
  • 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:

    EpochTimeUnitMillis number 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:

    DateTime string EpochTimeUnitMillis number

    Time unit for milliseconds

  • uuid string
  • version object
    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
    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:

      ByteSize number ByteSize string
    • retention object
      Hide retention attributes Show retention attributes object

      • size number | string

        One of:

        ByteSize number 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
    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:

      Stringifiedboolean boolean Stringifiedboolean string

  • priority number | string

    One of:

    number-1 number string-2 string
  • top_metrics_max_size number
  • analysis object
    Hide analysis attributes Show analysis attributes object

    • analyzer object
    • char_filter object
    • filter object
    • normalizer object
    • tokenizer object
  • settings object
  • time_series 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.

      One of:

      DateTime string EpochTimeUnitMillis 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:

      DateTime string EpochTimeUnitMillis number

      Time unit for milliseconds

  • queries object
    Hide queries attribute Show queries attribute object

    • cache object
      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
    Hide mapping attributes Show mapping attributes object

    • coerce boolean
    • total_fields 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.

        One of:

        number-1 number string-2 string

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

        One of:

        boolean-1 boolean string-2 string
    • depth object
      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
      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
      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
      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
      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.

    • source object
      Hide source attribute Show source attribute object

      • mode string Required

        Values are disabled, stored, or synthetic.

    • ignore_malformed boolean | string

      One of:

      boolean-1 boolean string-2 string
  • indexing.slowlog object
    Hide indexing.slowlog attributes Show indexing.slowlog attributes object

    • level string
    • source number
    • reformat boolean
    • threshold object
      Hide threshold attribute Show threshold attribute object

      • index object
        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
    Hide indexing_pressure attribute Show indexing_pressure attribute object

    • memory object Required
      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
    Hide store attributes Show store attributes object

    • type string Required

      Any of:

      StorageType string 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.

• remove_index_blocks boolean

  If index blocks should be removed when creating destination index (optional)