Get index templates Added in 7.9.0
Returns information about one or more index templates.
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.
GET
/_index_template
curl \
-X GET http://api.example.com/_index_template
Response examples (200)
{
"index_templates": [
{
"name": "string",
"index_template": {
"index_patterns": "string",
"composed_of": [
"string"
],
"template": {
"aliases": {
"additionalProperty1": {},
"additionalProperty2": {}
},
"mappings": {
"all_field": {},
"date_detection": true,
"dynamic": "strict",
"dynamic_date_formats": [
"string"
],
"dynamic_templates": [
{}
],
"_field_names": {},
"index_field": {},
"_meta": {},
"numeric_detection": true,
"properties": {},
"_routing": {},
"_size": {},
"_source": {},
"runtime": {},
"enabled": true,
"subobjects": true,
"_data_stream_timestamp": {}
},
"additionalProperty1": {
"additionalProperty1": {},
"additionalProperty2": {},
"mode": "string",
"soft_deletes": {},
"sort": {},
"number_of_routing_shards": 42.0,
"check_on_startup": "true",
"codec": "string",
"load_fixed_bitset_filters_eagerly": true,
"auto_expand_replicas": "string",
"merge": {},
"search": {},
"refresh_interval": "string",
"max_result_window": 42.0,
"max_inner_result_window": 42.0,
"max_rescore_window": 42.0,
"max_docvalue_fields_search": 42.0,
"max_script_fields": 42.0,
"max_ngram_diff": 42.0,
"max_shingle_diff": 42.0,
"blocks": {},
"max_refresh_listeners": 42.0,
"analyze": {},
"highlight": {},
"max_terms_count": 42.0,
"max_regex_length": 42.0,
"routing": {},
"gc_deletes": "string",
"default_pipeline": "string",
"final_pipeline": "string",
"lifecycle": {},
"provided_name": "string",
"uuid": "string",
"version": {},
"max_slices_per_scroll": 42.0,
"translog": {},
"query_string": {},
"top_metrics_max_size": 42.0,
"analysis": {},
"time_series": {},
"queries": {},
"similarity": {},
"mapping": {},
"indexing.slowlog": {},
"indexing_pressure": {},
"store": {}
},
"additionalProperty2": {
"additionalProperty1": {},
"additionalProperty2": {},
"mode": "string",
"soft_deletes": {},
"sort": {},
"number_of_routing_shards": 42.0,
"check_on_startup": "true",
"codec": "string",
"load_fixed_bitset_filters_eagerly": true,
"auto_expand_replicas": "string",
"merge": {},
"search": {},
"refresh_interval": "string",
"max_result_window": 42.0,
"max_inner_result_window": 42.0,
"max_rescore_window": 42.0,
"max_docvalue_fields_search": 42.0,
"max_script_fields": 42.0,
"max_ngram_diff": 42.0,
"max_shingle_diff": 42.0,
"blocks": {},
"max_refresh_listeners": 42.0,
"analyze": {},
"highlight": {},
"max_terms_count": 42.0,
"max_regex_length": 42.0,
"routing": {},
"gc_deletes": "string",
"default_pipeline": "string",
"final_pipeline": "string",
"lifecycle": {},
"provided_name": "string",
"uuid": "string",
"version": {},
"max_slices_per_scroll": 42.0,
"translog": {},
"query_string": {},
"top_metrics_max_size": 42.0,
"analysis": {},
"time_series": {},
"queries": {},
"similarity": {},
"mapping": {},
"indexing.slowlog": {},
"indexing_pressure": {},
"store": {}
},
"lifecycle": {
"data_retention": "string",
"downsampling": {},
"rollover": {}
}
},
"version": 42.0,
"priority": 42.0,
"_meta": {
"additionalProperty1": {},
"additionalProperty2": {}
},
"allow_auto_create": true,
"data_stream": {
"hidden": true,
"allow_custom_routing": true
},
"deprecated": true,
"ignore_missing_component_templates": "string"
}
}
]
}