get-component-template.asciidoc 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  1. [[getting-component-templates]]
  2. === Get component template API
  3. ++++
  4. <titleabbrev>Get component template</titleabbrev>
  5. ++++
  6. Retrieves information about one or more component templates.
  7. //////////////////////////
  8. [source,console]
  9. --------------------------------------------------
  10. PUT /_component_template/template_1
  11. {
  12. "template": {
  13. "settings": {
  14. "index.number_of_replicas": 0
  15. },
  16. "mappings": {
  17. "properties": {
  18. "@timestamp": {
  19. "type": "date"
  20. }
  21. }
  22. }
  23. }
  24. }
  25. --------------------------------------------------
  26. // TESTSETUP
  27. [source,console]
  28. --------------------------------------------------
  29. DELETE /_component_template/template_*
  30. --------------------------------------------------
  31. // TEARDOWN
  32. //////////////////////////
  33. [source,console]
  34. --------------------------------------------------
  35. GET /_component_template/template_1
  36. --------------------------------------------------
  37. [[get-component-template-api-request]]
  38. ==== {api-request-title}
  39. `GET /_component-template/<component-template>`
  40. [[get-component-template-api-path-params]]
  41. ==== {api-path-parms-title}
  42. `<component-template>`
  43. (Optional, string)
  44. Comma-separated list of component template names used to limit the request.
  45. Wildcard (`*`) expressions are supported.
  46. [[get-component-template-api-query-params]]
  47. ==== {api-query-parms-title}
  48. include::{docdir}/rest-api/common-parms.asciidoc[tag=flat-settings]
  49. include::{docdir}/rest-api/common-parms.asciidoc[tag=local]
  50. include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout]
  51. [[get-component-template-api-example]]
  52. ==== {api-examples-title}
  53. [[get-component-template-api-wildcard-ex]]
  54. ===== Get component templates using a wildcard expression
  55. [source,console]
  56. --------------------------------------------------
  57. GET /_component_template/temp*
  58. --------------------------------------------------
  59. [[get-component-template-api-all-ex]]
  60. ===== Get all component templates
  61. [source,console]
  62. --------------------------------------------------
  63. GET /_component_template
  64. --------------------------------------------------