delete-data-stream.asciidoc 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. [role="xpack"]
  2. [[indices-delete-data-stream]]
  3. === Delete data stream API
  4. ++++
  5. <titleabbrev>Delete data stream</titleabbrev>
  6. ++++
  7. Deletes one or more <<data-streams,data streams>> and their backing
  8. indices. See <<delete-data-stream>>.
  9. ////
  10. [source,console]
  11. ----
  12. PUT /_index_template/template
  13. {
  14. "index_patterns": ["my-data-stream*"],
  15. "data_stream": { }
  16. }
  17. PUT /_data_stream/my-data-stream
  18. ----
  19. // TESTSETUP
  20. ////
  21. [source,console]
  22. ----
  23. DELETE /_data_stream/my-data-stream
  24. ----
  25. ////
  26. [source,console]
  27. ----
  28. DELETE /_index_template/template
  29. ----
  30. // TEST[continued]
  31. ////
  32. [[delete-data-stream-api-request]]
  33. ==== {api-request-title}
  34. `DELETE /_data_stream/<data-stream>`
  35. [[delete-data-stream-api-prereqs]]
  36. ==== {api-prereq-title}
  37. * If the {es} {security-features} are enabled, you must have the `delete_index`
  38. or `manage` <<privileges-list-indices,index privilege>> for the data stream.
  39. [[delete-data-stream-api-path-params]]
  40. ==== {api-path-parms-title}
  41. `<data-stream>`::
  42. (Required, string)
  43. Comma-separated list of data streams to delete.
  44. Wildcard (`*`) expressions are supported.
  45. [role="child_attributes"]
  46. [[delete-data-stream-api-query-parms]]
  47. ==== {api-query-parms-title}
  48. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ds-expand-wildcards]
  49. +
  50. Defaults to `open`.