You're viewing version 2.16 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.
CAT templates
Introduced 1.0
The CAT templates operation lists the names, patterns, order numbers, and version numbers of index templates.
Path and HTTP methods
GET _cat/templates
URL parameters
All CAT templates URL parameters are optional.
In addition to the common URL parameters, you can specify the following parameters:
| Parameter | Type | Description |
|---|---|---|
| local | Boolean | Whether to return information from the local node only instead of from the cluster manager node. Default is false. |
| cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds. |
Example requests
The following example request returns information about all templates:
GET _cat/templates?v
If you want to get information for a specific template or pattern:
GET _cat/templates/<template_name_or_pattern>
Example response
name | index_patterns order version composed_of
tenant_template | [opensearch-dashboards*] | 0 |
To learn more about index templates, see Index templates.