- Kibana Guide: other versions:
- What is Kibana?
- What’s new in 8.10
- Kibana concepts
- Quick start
- Set up
- Install Kibana
- Configure Kibana
- Alerting and action settings
- APM settings
- Banners settings
- Cases settings
- Enterprise Search settings
- Fleet settings
- i18n settings
- Logging settings
- Logs settings
- Metrics settings
- Monitoring settings
- Reporting settings
- Search sessions settings
- Secure settings
- Security settings
- Spaces settings
- Task Manager settings
- Telemetry settings
- URL drilldown settings
- Start and stop Kibana
- Access Kibana
- Securing access to Kibana
- Add data
- Upgrade Kibana
- Configure security
- Configure reporting
- Configure logging
- Configure monitoring
- Command line tools
- Production considerations
- Discover
- Dashboard and visualizations
- Canvas
- Maps
- Build a map to compare metrics by country or region
- Track, visualize, and alert on assets in real time
- Map custom regions with reverse geocoding
- Heat map layer
- Tile layer
- Vector layer
- Plot big data
- Search geographic data
- Configure map settings
- Connect to Elastic Maps Service
- Import geospatial data
- Troubleshoot
- Reporting and sharing
- Machine learning
- Graph
- Alerting
- Observability
- APM
- Set up
- Get started
- How-to guides
- Configure APM agents with central config
- Control access to APM data
- Create an alert
- Create custom links
- Filter data
- Find transaction latency and failure correlations
- Identify deployment details for APM agents
- Integrate with machine learning
- Observe Lambda functions
- Query your data
- Storage Explorer
- Track deployments with annotations
- Users and privileges
- Settings
- REST API
- Troubleshooting
- Security
- Dev Tools
- Fleet
- Osquery
- Stack Monitoring
- Stack Management
- REST API
- Get features API
- Kibana spaces APIs
- Kibana role management APIs
- User session management APIs
- Saved objects APIs
- Data views API
- Get all data views
- Get data view
- Create data view
- Update data view
- Delete data view
- Swap references preview
- Swap references
- Get default data view
- Set default data view
- Update data view fields metadata
- Get runtime field
- Create runtime field
- Upsert runtime field
- Update runtime field
- Delete runtime field
- Index patterns APIs
- Alerting APIs
- Action and connector APIs
- Cases APIs
- Add comment
- Create case
- Delete cases
- Delete comments
- Find case activity
- Find cases
- Find connectors
- Get alerts
- Get case activity
- Get case
- Get case status
- Get cases by alert
- Get comments
- Get configuration
- Get reporters
- Get tags
- Push case
- Set configuration
- Update cases
- Update comment
- Update configuration
- Import and export dashboard APIs
- Logstash configuration management APIs
- Machine learning APIs
- Osquery manager API
- Short URLs APIs
- Get Task Manager health
- Upgrade assistant APIs
- Kibana plugins
- Troubleshooting
- Accessibility
- Release notes
- Kibana 8.10.4
- Kibana 8.10.3
- Kibana 8.10.2
- Kibana 8.10.1
- Kibana 8.10.0
- Kibana 8.9.2
- Kibana 8.9.1
- Kibana 8.9.0
- Kibana 8.8.2
- Kibana 8.8.1
- Kibana 8.8.0
- Kibana 8.7.1
- Kibana 8.7.0
- Kibana 8.6.1
- Kibana 8.6.0
- Kibana 8.5.2
- Kibana 8.5.1
- Kibana 8.5.0
- Kibana 8.4.3
- Kibana 8.4.2
- Kibana 8.4.1
- Kibana 8.4.0
- Kibana 8.3.3
- Kibana 8.3.2
- Kibana 8.3.1
- Kibana 8.3.0
- Kibana 8.2.3
- Kibana 8.2.2
- Kibana 8.2.1
- Kibana 8.2.0
- Kibana 8.1.3
- Kibana 8.1.2
- Kibana 8.1.1
- Kibana 8.1.0
- Kibana 8.0.0
- Kibana 8.0.0-rc2
- Kibana 8.0.0-rc1
- Kibana 8.0.0-beta1
- Kibana 8.0.0-alpha2
- Kibana 8.0.0-alpha1
- Developer guide
Update case comment API
editUpdate case comment API
editUpdates a comment or alert in a case.
For the most up-to-date API details, refer to the open API specification.
Request
editPATCH <kibana host>:<port>/api/cases/<case_id>/comments
PATCH <kibana host>:<port>/s/<space_id>/api/cases/<case_id>/comments
Prerequisites
editYou 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 parameters
edit-
<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 body
edit-
alertId
-
(Required*, string or array of strings) The alert identifiers. It is
required only when
type
isalert
. If you are adding multiple alerts to a case, use an array of strings;index
must also be an array with the same length or number of elements in that case. Addings multiple alerts in this manner is recommended rather than calling the API multiple times. -
comment
-
(Required*, string) The updated comment. It is required only when
type
isuser
. -
id
- (Required, string) The identifier for the comment. To retrieve comment IDs, use Get comments.
-
index
-
(Required*, string or array of strings) The alert indices. It is required only
when
type
isalert
. If you are adding multiple alerts to a case, use an array of strings;alertId
must also be an array with the same length or number of elements. [preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work 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
, orsecuritySolution
.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
isalert
. [preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work 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 work 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 work 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
oralert
.You cannot change the comment type.
-
version
- (Required, string) The current comment version. To retrieve version values, use Get comments.
Response codes
edit-
200
- Indicates a successful call.
Examples
editUpdate 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" } }