Query parameters

• localboolean

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

  If true, returns settings in flat format.

• master_timeoutstring

  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.

  Values are -1 or 0.

• include_defaultsboolean

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

Responses

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

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

    • namestring Required
    • index_templateobject Required
      Hide index_template attributes Show index_template attributes object

      • index_patternsstring | array[string] Required
      • composed_ofarray[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.

      • templateobject
        Hide template attributes Show template attributes object

        • aliasesobject

          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
        • mappingsobject
          Hide mappings attributes Show mappings attributes object

          • all_fieldobject
          • date_detectionboolean
          • dynamicstring

            Values are strict, runtime, true, or false.

          • dynamic_date_formatsarray[string]
          • dynamic_templatesarray[object]
          • _field_namesobject
          • index_fieldobject
          • _metaobject
          • numeric_detectionboolean
          • propertiesobject
          • _routingobject
          • _sizeobject
          • _sourceobject
          • runtimeobject
          • enabledboolean
          • subobjectsstring

            Values are true or false.

          • _data_stream_timestampobject
        • settingsobject
          Hide settings attributes Show settings attributes object

          • indexobject
          • modestring
          • routing_path
          • soft_deletesobject
          • sortobject
          • number_of_shards
          • number_of_replicas
          • number_of_routing_shardsnumber
          • check_on_startupstring

            Values are true, false, or checksum.

          • codecstring
          • routing_partition_size
          • load_fixed_bitset_filters_eagerlyboolean
          • hidden
          • auto_expand_replicas
          • mergeobject
          • searchobject
          • refresh_intervalstring

            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_windownumber
          • max_inner_result_windownumber
          • max_rescore_windownumber
          • max_docvalue_fields_searchnumber
          • max_script_fieldsnumber
          • max_ngram_diffnumber
          • max_shingle_diffnumber
          • blocksobject
          • max_refresh_listenersnumber
          • analyzeobject
          • highlightobject
          • max_terms_countnumber
          • max_regex_lengthnumber
          • routingobject
          • gc_deletesstring

            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_pipelinestring
          • final_pipelinestring
          • lifecycleobject
          • provided_namestring
          • creation_date
          • creation_date_string
          • uuidstring
          • versionobject
          • verified_before_close
          • format
          • max_slices_per_scrollnumber
          • translogobject
          • query_stringobject
          • priority
          • top_metrics_max_sizenumber
          • analysisobject
          • settingsobject
          • time_seriesobject
          • queriesobject
          • similarityobject

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

          • mappingobject
          • indexing.slowlogobject
          • indexing_pressureobject
          • storeobject
        • lifecycleobject
      • versionnumber
      • prioritynumber

        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.

      • _metaobject
        Hide _meta attribute Show _meta attribute object

        • *object Additional properties
      • allow_auto_createboolean
      • data_streamobject
        Hide data_stream attributes Show data_stream attributes object

        • hiddenboolean

          If true, the data stream is hidden.

        • allow_custom_routingboolean

          If true, the data stream supports custom routing.

      • deprecatedboolean

        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_templatesstring | array[string]