get-index-template.asciidoc 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. [[indices-get-template-v1]]
  2. === Get index template API
  3. ++++
  4. <titleabbrev>Get index template</titleabbrev>
  5. ++++
  6. Returns information about one or more index templates.
  7. ////
  8. [source,console]
  9. --------------------------------------------------
  10. PUT _template/template_1
  11. {
  12. "index_patterns" : ["te*"],
  13. "settings": {
  14. "number_of_shards": 1
  15. }
  16. }
  17. --------------------------------------------------
  18. // TESTSETUP
  19. [source,console]
  20. --------------------------------------------------
  21. DELETE _template/template_1
  22. --------------------------------------------------
  23. // TEARDOWN
  24. ////
  25. [source,console]
  26. --------------------------------------------------
  27. GET /_template/template_1
  28. --------------------------------------------------
  29. [[get-template-v1-api-request]]
  30. ==== {api-request-title}
  31. `GET /_template/<index-template>`
  32. [[get-template-v1-api-path-params]]
  33. ==== {api-path-parms-title}
  34. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-template]
  35. +
  36. To return all index templates, omit this parameter
  37. or use a value of `_all` or `*`.
  38. [[get-template-v1-api-query-params]]
  39. ==== {api-query-parms-title}
  40. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings]
  41. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local]
  42. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
  43. [[get-template-v1-api-example]]
  44. ==== {api-examples-title}
  45. [[get-template-v1-api-multiple-ex]]
  46. ===== Get multiple index templates
  47. [source,console]
  48. --------------------------------------------------
  49. GET /_template/template_1,template_2
  50. --------------------------------------------------
  51. [[get-template-v1-api-wildcard-ex]]
  52. ===== Get index templates using a wildcard expression
  53. [source,console]
  54. --------------------------------------------------
  55. GET /_template/temp*
  56. --------------------------------------------------
  57. [[get-template-v1-api-all-ex]]
  58. ===== Get all index templates
  59. [source,console]
  60. --------------------------------------------------
  61. GET /_template
  62. --------------------------------------------------