Path parameters

• name string Required

  Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.

Query parameters

• local boolean

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

• flat_settings boolean

  If true, returns settings in flat format.

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

• include_defaults boolean

  If true, returns all relevant default configurations for the index template.

Responses

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

  • index_templates array[object] Required
    Hide index_templates attributes Show index_templates attributes object

    • name string Required
    • index_template object Required

      Additional properties are allowed.

      Hide index_template attributes Show index_template attributes object

      • index_patterns string | array[string] Required
      • composed_of array[string] Required

        An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.

      • template object

        Additional properties are allowed.

        Hide template attributes Show template attributes object

        • aliases object

          Aliases to add. If the index template includes a data_stream object, these are data stream aliases. Otherwise, these are index aliases. Data stream aliases ignore the index_routing, routing, and search_routing options.

          Hide aliases attribute Show aliases attribute object

          • * object Additional properties

            Additional properties are allowed.

        • mappings object

          Additional properties are allowed.

          Hide mappings attributes Show mappings attributes object

          • all_field object

            Additional properties are allowed.

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

          • index_field object

            Additional properties are allowed.

          • _meta object
          • numeric_detection boolean
          • properties object
          • _routing object

            Additional properties are allowed.

          • _size object

            Additional properties are allowed.

          • _source object

            Additional properties are allowed.

          • runtime object
          • enabled boolean
          • subobjects boolean
          • _data_stream_timestamp object

            Additional properties are allowed.

        • 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
          • soft_deletes object

            Additional properties are allowed.

          • sort object

            Additional properties are allowed.

          • number_of_shards
          • number_of_replicas
          • number_of_routing_shards number
          • check_on_startup string

            Values are true, false, or checksum.

          • codec string
          • routing_partition_size
          • load_fixed_bitset_filters_eagerly boolean
          • hidden
          • auto_expand_replicas string
          • merge object

            Additional properties are allowed.

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

          • max_refresh_listeners number
          • analyze object

            Additional properties are allowed.

          • highlight object

            Additional properties are allowed.

          • max_terms_count number
          • max_regex_length number
          • routing object

            Additional properties are allowed.

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

          • provided_name string
          • creation_date
          • creation_date_string
          • uuid string
          • version object

            Additional properties are allowed.

          • verified_before_close
          • format
          • max_slices_per_scroll number
          • translog object

            Additional properties are allowed.

          • query_string object

            Additional properties are allowed.

          • priority
          • top_metrics_max_size number
          • analysis object

            Additional properties are allowed.

          • settings object Additional properties

            Additional properties are allowed.

          • time_series object

            Additional properties are allowed.

          • queries object

            Additional properties are allowed.

          • similarity object

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

          • mapping object

            Additional properties are allowed.

          • indexing.slowlog object

            Additional properties are allowed.

          • indexing_pressure object

            Additional properties are allowed.

          • store object

            Additional properties are allowed.

        • lifecycle object

          Additional properties are allowed.

      • version number
      • priority number

        Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by Elasticsearch.

      • _meta object
        Hide _meta attribute Show _meta attribute object

        • * object Additional properties

          Additional properties are allowed.

      • allow_auto_create boolean
      • data_stream object

        Additional properties are allowed.

        Hide data_stream attributes Show data_stream attributes object

        • hidden boolean

          If true, the data stream is hidden.

        • allow_custom_routing boolean

          If true, the data stream supports custom routing.

      • deprecated boolean

        Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning.

      • ignore_missing_component_templates string | array[string]