elasticsearch/docs/reference/behavioral-analytics/apis/delete-analytics-collection.asciidoc
Lisa Cawley 5e0fbef58b
[DOCS] Link to new API site (#119038)
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
2024-12-30 16:52:16 +00:00

61 lines
1.3 KiB
Text

[role="xpack"]
[[delete-analytics-collection]]
=== Delete Analytics Collection
beta::[]
++++
<titleabbrev>Delete Analytics Collection</titleabbrev>
++++
.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-analytics[Behavioral analytics APIs].
--
////
[source,console]
----
PUT _application/analytics/my_analytics_collection
----
// TESTSETUP
////
Removes a <<behavioral-analytics-overview,Behavioral Analytics>> Collection and its associated data stream.
[[delete-analytics-collection-request]]
==== {api-request-title}
`DELETE _application/analytics/<name>`
[[delete-analytics-collection-prereq]]
==== {api-prereq-title}
Requires the `manage_behavioral_analytics` cluster privilege.
[[delete-analytics-collection-path-params]]
==== {api-path-parms-title}
`<name>`::
(Required, string)
[[delete-analytics-collection-response-codes]]
==== {api-response-codes-title}
`400`::
The `name` was not provided.
`404` (Missing resources)::
No Analytics Collection matching `name` could be found.
[[delete-analytics-collection-example]]
==== {api-examples-title}
The following example deletes the Analytics Collection named `my_analytics_collection`:
[source,console]
----
DELETE _application/analytics/my_analytics_collection/
----