mirror of
https://github.com/elastic/kibana.git
synced 2025-06-28 11:05:39 -04:00
63 lines
1.9 KiB
Text
63 lines
1.9 KiB
Text
[[cases-api-delete-comments]]
|
|
== Delete comments from case API
|
|
++++
|
|
<titleabbrev>Delete comments</titleabbrev>
|
|
++++
|
|
|
|
Deletes one or all comments and alerts from a case.
|
|
|
|
=== {api-request-title}
|
|
|
|
`DELETE <kibana host>:<port>/api/cases/<case_id>/comments`
|
|
|
|
`DELETE <kibana host>:<port>/api/cases/<case_id>/comments/<comment_id>`
|
|
|
|
`DELETE <kibana host>:<port>/s/<space_id>/api/cases/<case_id>/comments`
|
|
|
|
`DELETE <kibana host>:<port>/s/<space_id>/api/cases/<case_id>/comments/<comment_id>`
|
|
|
|
=== {api-prereq-title}
|
|
|
|
You must have `read` or `all` privileges and the `delete` sub-feature privilege
|
|
for the *Cases* feature in the *Management*, *{observability}*, or *Security*
|
|
section of the <<kibana-feature-privileges,{kib} feature privileges>>, depending
|
|
on the `owner` of the cases you're updating.
|
|
|
|
=== {api-path-parms-title}
|
|
|
|
`<case_id>`::
|
|
(Required, string) The identifier for the case. To retrieve case IDs, use
|
|
<<cases-api-find-cases>>.
|
|
|
|
`<comment_id>`::
|
|
(Optional, string) The identifier for the comment. To retrieve comment IDs, use
|
|
<<cases-api-get-case>> or <<cases-api-find-cases>>. If it is not specified, all
|
|
comments are deleted.
|
|
|
|
<space_id>::
|
|
(Optional, string) An identifier for the space. If it is not specified, the
|
|
default space is used.
|
|
|
|
=== {api-response-codes-title}
|
|
|
|
`204`::
|
|
Indicates a successful call.
|
|
|
|
=== {api-examples-title}
|
|
|
|
Delete all comments from case ID `9c235210-6834-11ea-a78c-6ffb38a34414`:
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
DELETE api/cases/a18b38a0-71b0-11ea-a0b2-c51ea50a58e2/comments
|
|
--------------------------------------------------
|
|
// KIBANA
|
|
|
|
Delete comment ID `71ec1870-725b-11ea-a0b2-c51ea50a58e2` from case ID
|
|
`a18b38a0-71b0-11ea-a0b2-c51ea50a58e2`:
|
|
|
|
[source,sh]
|
|
--------------------------------------------------
|
|
DELETE api/cases/a18b38a0-71b0-11ea-a0b2-c51ea50a58e2/comments/71ec1870-725b-11ea-a0b2-c51ea50a58e2
|
|
--------------------------------------------------
|
|
// KIBANA
|