Update case comment APIedit

Updates a comment or alert in a case.

Requestedit

PATCH <kibana host>:<port>/api/cases/<case_id>/comments

PATCH <kibana host>:<port>/s/<space_id>/api/cases/<case_id>/comments

Prerequisitesedit

You must have all privileges for the Cases feature in the Management, Observability, or Security section of the Kibana feature privileges, depending on the owner of the case you’re updating.

Path parametersedit

<case_id>
The identifier for the case. To retrieve case IDs, use Find cases.
<space_id>
(Optional, string) An identifier for the space. If it is not specified, the default space is used.

Request bodyedit

alertId
(Required*, string or array of strings) The identifier for the alert. It is required only when type is alert. If it is an array, index must also be an array. [preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
comment
(Required*, string) The updated comment. It is required only when type is user.
id
(Required, string) The identifier for the comment. To retrieve comment IDs, use Get comments.
index
(Required*, string or array of strings) The alert index. It is required only when type is alert. If it is an array, alertId must also be an array. [preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
owner

(Required, string) The application that owns the case. It can be cases, observability, or securitySolution.

You cannot change the owner of a comment.

rule

(Required*, object) The rule that is associated with the alert. It is required only when type is alert. [preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.

Properties of rule
id
(Required, string) The rule identifier. [preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
name
(Required, string) The rule name. [preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
type

(Required, string) The comment type, which must be user or alert.

You cannot change the comment type.

version
(Required, string) The current comment version. To retrieve version values, use Get comments.

Response codesedit

200
Indicates a successful call.

Examplesedit

Update comment ID 8af6ac20-74f6-11ea-b83a-553aecdb28b6 (associated with case ID 293f1bc0-74f6-11ea-b83a-553aecdb28b6):

PATCH api/cases/293f1bc0-74f6-11ea-b83a-553aecdb28b6/comments
{
  "id": "8af6ac20-74f6-11ea-b83a-553aecdb28b6",
  "version": "Wzk1LDFd",
  "type": "user",
  "comment": "An updated comment."
}

The API returns details about the case and its comments. For example:

{
  "comments":[{
    "id": "8af6ac20-74f6-11ea-b83a-553aecdb28b6",
    "version": "WzIwNjM3LDFd",
    "comment": "An updated comment.",
    "type": "user",
    "owner": "cases",
    "created_at": "2022-03-24T00:37:10.832Z",
    "created_by": {
        "email": null,
        "full_name": null,
        "username": "elastic"
    },
    "pushed_at": null,
    "pushed_by": null,
    "updated_at": "2022-03-24T01:27:06.210Z",
    "updated_by": {
        "email": null,
        "full_name": null,
        "username": "elastic"
      }
    }
  ],
  "totalAlerts": 0,
  "id": "293f1bc0-74f6-11ea-b83a-553aecdb28b6",
  "version": "WzIwNjM2LDFd",
  "totalComment": 1,
  "title": "Case title 1",
  "tags": ["tag 1"],
  "description": "A case description.",
  "settings": {"syncAlerts":false},
  "owner": "cases",
  "duration": null,
  "severity": "low",
  "closed_at": null,
  "closed_by": null,
  "created_at": "2022-03-24T00:37:03.906Z",
  "created_by": {
    "email": null,
    "full_name": null,
    "username": "elastic"
  },
  "status": "open",
  "updated_at": "2022-03-24T01:27:06.210Z",
  "updated_by": {
    "email": null,
    "full_name": null,
    "username": "elastic"
  },
  "connector": {
    "id": "none",
    "name": "none",
    "type": ".none",
    "fields": null
  },
  "external_service": null
}

Update an alert in the case:

PATCH api/cases/293f1bc0-74f6-11ea-b83a-553aecdb28b6/comments
{
  "id": "73362370-ab1a-11ec-985f-97e55adae8b9",
  "version": "WzMwNDgsMV0=",
  "type": "alert",
  "owner": "cases",
  "alertId": "c8789278659fdf88b7bf7709b90a082be070d0ba4c23c9c4b552e476c2a667c4",
  "index": ".internal.alerts-security.alerts-default-000001",
  "rule":
  {
    "id":"94d80550-aaf4-11ec-985f-97e55adae8b9",
    "name":"security_rule"
  }
}