1.3 KiB
1.3 KiB
| layout | title | parent | nav_order | has_children |
|---|---|---|---|---|
| default | CAT templates | CAT API | 70 | false |
CAT templates
Introduced 1.0 {: .label .label-purple }
The CAT Templates operation lists the names, patterns, order numbers, and version numbers of index templates.
Example
GET _cat/templates?v
{% include copy-curl.html %}
If you want to get information for a specific template or pattern:
GET _cat/templates/<template_name_or_pattern>
{% include copy-curl.html %}
Path and HTTP methods
GET _cat/templates
{% include copy-curl.html %}
URL parameters
All CAT templates URL parameters are optional.
In addition to the common URL parameters, you can specify the following parameter:
| 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. |
Response
name | index_patterns order version composed_of
tenant_template | [opensearch-dashboards*] | 0 |
To learn more about index templates, see Index templates.