Search + K

Command Palette

Search for a command to run...

Sign In

Get component templates

GET /_component_template
Copy endpoint

Get information about component templates.

Required authorization

  • Cluster privileges: manage_index_templates

Parameters

query Query Parameters

Name Type
flat_settings

If true, returns settings in flat format.

boolean
settings_filter

Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys

string[] | string
include_defaults

Return all default configurations for the component template

boolean
local deprecated

If true, the request retrieves information from the local node only. If false, information is retrieved from the master node.

boolean
master_timeout

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

type TypesDuration = string | "-1" | "0"

Responses

200 application/json
{ component_templates: ClusterTypesComponentTemplate
interface ClusterTypesComponentTemplate {
name: TypesName;
component_template: ClusterTypesComponentTemplateNode;
}
[]
; }