This version of the OpenSearch documentation 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.

Example

  1. GET _cat/templates?v

copy

If you want to get information for a specific template or pattern:

  1. GET _cat/templates/<template_name_or_pattern>

copy

Path and HTTP methods

  1. GET _cat/templates

copy

URL parameters

All CAT templates URL parameters are optional.

In addition to the common URL parameters, you can specify the following parameters:

ParameterTypeDescription
localBooleanWhether to return information from the local node only instead of from the cluster manager node. Default is false.
cluster_manager_timeoutTimeThe amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.

Response

  1. name | index_patterns order version composed_of
  2. tenant_template | [opensearch-dashboards*] | 0  |

To learn more about index templates, see Index templates.