Get index templates | Elasticsearch API documentation (original) (raw)

Dismiss highlight Show more

Path parameters

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

Query parameters

• If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.
• If true, returns settings in flat format.
• 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.
• If true, returns all relevant default configurations for the index template.

Responses

• 200 application/json
  Hide response attribute Show response attribute object
  • Hide index_templates attributes Show index_templates attributes object
    * Hide index_template attributes Show index_template attributes object
    * 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.
    * Hide template attributes Show template attributes 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
    * Hide mappings attributes Show mappings attributes object
    * Values are strict, runtime, true, or false.
    * Values are true or false.
    * Hide settings attributes Show settings attributes object
    * Values are true, false, or checksum.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Configure custom similarity settings to customize how search results are scored.
    * 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.
    * Hide _meta attribute Show _meta attribute object
    * *
    object Additional properties
    * Hide data_stream attributes Show data_stream attributes object
    * If true, the data stream is hidden.
    * If true, the data stream supports custom routing.
    * 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.