put-analytics-collection.asciidoc 1.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. [role="xpack"]
  2. [[put-analytics-collection]]
  3. === Put Analytics Collection
  4. beta::[]
  5. ++++
  6. <titleabbrev>Put 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. DELETE _application/analytics/my_analytics_collection
  17. ----
  18. // TEARDOWN
  19. ////
  20. Creates a <<behavioral-analytics-overview,Behavioral Analytics>> Collection.
  21. [[put-analytics-collection-request]]
  22. ==== {api-request-title}
  23. `PUT _application/analytics/<name>`
  24. [[put-analytics-collection-path-params]]
  25. ==== {api-path-parms-title}
  26. `<name>`::
  27. (Required, string)
  28. [[put-analytics-collection-prereqs]]
  29. ==== {api-prereq-title}
  30. Requires the `manage_behavioral_analytics` cluster privilege.
  31. [[put-analytics-collection-response-codes]]
  32. ==== {api-response-codes-title}
  33. `400`::
  34. Analytics Collection `<name>` exists.
  35. [[put-analytics-collection-example]]
  36. ==== {api-examples-title}
  37. The following example creates a new Analytics Collection called `my_analytics_collection`:
  38. [source,console]
  39. ----
  40. PUT _application/analytics/my_analytics_collection
  41. ----