Link Search Menu Expand Document Documentation Menu

You're viewing version 2.17 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Get index template

The Get Index Template API returns information about one or more index templates.

Path and HTTP methods

GET /_index_template/<template-name>

Query parameters

The following optional query parameters are supported.

Parameter Type Description
create Boolean When true, the API cannot replace or update any existing index templates. Default is false.
cluster_manager_timeout Time The amount of time to wait for a connection to the cluster manager node. Default is 30s.
flat_settings Boolean Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the flat form of “index”: { “creation_date”: “123456789” } is “index.creation_date”: “123456789”.

Example requests

The following example request gets information about an index template by using a wildcard expression:

GET /_index_template/h*

The following example request gets information about all index templates:

GET /_index_template

350 characters left

Have a question? .

Want to contribute? or .