delete-analytics-collection.asciidoc 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. [role="xpack"]
  2. [[delete-analytics-collection]]
  3. === Delete Analytics Collection
  4. beta::[]
  5. ++++
  6. <titleabbrev>Delete Analytics Collection</titleabbrev>
  7. ++++
  8. .New API reference
  9. [sidebar]
  10. --
  11. For the most up-to-date API details, refer to {api-es}/group/endpoint-analytics[Behavioral analytics APIs].
  12. --
  13. ////
  14. [source,console]
  15. ----
  16. PUT _application/analytics/my_analytics_collection
  17. ----
  18. // TESTSETUP
  19. ////
  20. Removes a <<behavioral-analytics-overview,Behavioral Analytics>> Collection and its associated data stream.
  21. [[delete-analytics-collection-request]]
  22. ==== {api-request-title}
  23. `DELETE _application/analytics/<name>`
  24. [[delete-analytics-collection-prereq]]
  25. ==== {api-prereq-title}
  26. Requires the `manage_behavioral_analytics` cluster privilege.
  27. [[delete-analytics-collection-path-params]]
  28. ==== {api-path-parms-title}
  29. `<name>`::
  30. (Required, string)
  31. [[delete-analytics-collection-response-codes]]
  32. ==== {api-response-codes-title}
  33. `400`::
  34. The `name` was not provided.
  35. `404` (Missing resources)::
  36. No Analytics Collection matching `name` could be found.
  37. [[delete-analytics-collection-example]]
  38. ==== {api-examples-title}
  39. The following example deletes the Analytics Collection named `my_analytics_collection`:
  40. [source,console]
  41. ----
  42. DELETE _application/analytics/my_analytics_collection/
  43. ----