You're viewing version 2.18 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.
Endpoints
GET /_cat/templates
GET /_cat/templates/{name}
Query parameters
The following table lists the available query parameters. All query parameters are optional.
| Parameter | Data type | Description | Default |
|---|---|---|---|
cluster_manager_timeout | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A |
format | String | A short version of the Accept header, such as json or yaml. | N/A |
h | List | A comma-separated list of column names to display. | N/A |
help | Boolean | Returns help information. | false |
local | Boolean | Returns local information but does not retrieve the state from the cluster manager node. | false |
s | List | A comma-separated list of column names or column aliases to sort by. | N/A |
v | Boolean | Enables verbose mode, which displays column headers. | false |
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.