This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
cat component templates API
editcat component templates API
editcat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get component template API.
Returns information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have the
monitor
ormanage
cluster privilege to use this API.
Path parameters
edit-
<template_name>
- (Optional, string) The name of the component template to return. Accepts wildcard expressions. If omitted, all component templates are returned.
Query parameters
edit-
format
- (Optional, string) Short version of the HTTP accept header. Valid values include JSON, YAML, etc.
-
h
- (Optional, string) Comma-separated list of column names to display.
-
help
-
(Optional, Boolean) If
true
, the response includes help information. Defaults tofalse
. -
local
-
(Optional, Boolean) If
true
, the request retrieves information from the local node only. Defaults tofalse
, which means information is retrieved from the master node. -
master_timeout
-
(Optional, time units)
Period to wait for the master node. If the master node is not available before
the timeout expires, the request fails and returns an error. Defaults to
30s
. Can also be set to-1
to indicate that the request should never timeout. -
s
- (Optional, string) Comma-separated list of column names or column aliases used to sort the response.
-
v
-
(Optional, Boolean) If
true
, the response includes column headings. Defaults tofalse
.
Examples
editresp = client.cat.component_templates( name="my-template-*", v=True, s="name", ) print(resp)
response = client.cat.component_templates( name: 'my-template-*', v: true, s: 'name' ) puts response
const response = await client.cat.componentTemplates({ name: "my-template-*", v: "true", s: "name", }); console.log(response);
GET _cat/component_templates/my-template-*?v=true&s=name
The API returns the following response:
name version alias_count mapping_count settings_count metadata_count included_in my-template-1 0 0 1 0 [my-index-template] my-template-2 0 3 0 0 [my-index-template]