- Kibana Guide: other versions:
- What is Kibana?
- What’s new in 8.13
- 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
- Exploring mobile sessions with Discover
- Viewing sessions with Discover
- 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
- Synthetics APIs
- Uptime APIs
- Kibana plugins
- Troubleshooting
- Accessibility
- Release notes
- Kibana 8.13.4
- Kibana 8.13.3
- Kibana 8.13.2
- Kibana 8.13.1
- Kibana 8.13.0
- Kibana 8.12.2
- Kibana 8.12.1
- Kibana 8.12.0
- Kibana 8.11.4
- Kibana 8.11.3
- Kibana 8.11.2
- Kibana 8.11.1
- Kibana 8.11.0
- 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
Find cases API
editFind cases API
editRetrieves a paginated subset of cases.
For the most up-to-date API details, refer to the open API specification.
Request
editGET <kibana host>:<port>/api/cases/_find
GET <kibana host>:<port>/s/<space_id>/api/cases/_find
Prerequisites
editYou must have read
privileges for the Cases feature in the Management,
Observability, or Security section of the
Kibana feature privileges, depending on the
owner
of the cases you’re seeking.
Path parameters
edit-
<space_id>
- (Optional, string) An identifier for the space. If it is not specified, the default space is used.
Query parameters
edit-
assignees
-
(Optional, string or array of strings) Filters the returned cases by assignees.
Valid values are
none
or unique identifiers for the user profiles. These identifiers can be found by using the suggest user profile API. -
defaultSearchOperator
-
(Optional, string) The default operator to use for the
simple_query_string
. Defaults toOR
. -
from
- (Optional, string) Returns only cases that were created after a specific date. The date must be specified as a KQL data range or date match expression. [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
-
(Optional, string or array of strings) A filter to limit the retrieved cases to
a specific set of applications. Valid values are:
cases
,observability
, andsecuritySolution
. If this parameter is omitted, the response contains all cases that the user has access to read. -
page
-
(Optional, integer) The page number to return. Defaults to
1
. -
perPage
-
(Optional, integer) The number of rules to return per page. Defaults to
20
. -
reporters
-
(Optional, string or array of strings) Filters the returned cases by the
reporter’s
username
. -
search
- (Optional, string) An Elasticsearch simple_query_string query that filters the objects in the response.
-
searchFields
-
(Optional, string or array of strings) The fields to perform the
simple_query_string
parsed query against. -
severity
-
(Optional,string) The severity of the case. Valid values are:
critical
,high
,low
, andmedium
. -
sortField
-
(Optional, string) Determines which field is used to sort the results,
createdAt
orupdatedAt
. Defaults tocreatedAt
.Even though the JSON case object uses
created_at
andupdated_at
fields, you must usecreatedAt
andupdatedAt
fields in the URL query. -
sortOrder
-
(Optional, string) Determines the sort order, which can be
desc
orasc
. Defaults todesc
. -
status
-
(Optional, string) Filters the returned cases by state, which can be
open
,in-progress
, orclosed
. -
tags
- (Optional, string or array of strings) Filters the returned cases by tags.
-
to
- (Optional, string) Returns only cases that were created before a specific date. The date must be specified as a KQL data range or date match expression. [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.
Response codes
edit-
200
- Indicates a successful call.
Examples
editRetrieve the first five cases with the tag-1
tag, in ascending order by
last update time:
GET api/cases/_find?page=1&perPage=5&sortField=updatedAt&sortOrder=asc&tags=tag-1
The API returns a JSON object listing the retrieved cases. For example:
{ "page": 1, "per_page": 5, "total": 1, "cases": [ { "id": "abed3a70-71bd-11ea-a0b2-c51ea50a58e2", "version": "WzExMCwxXQ==", "comments": [], "totalComment": 1, "totalAlerts": 0, "title": "Case title", "tags": [ "tag-1" ], "description": "Case description", "settings": { "syncAlerts": true }, "owner": "securitySolution", "duration": null, "severity": "low", "closed_at": null, "closed_by": null, "created_at": "2022-05-12T00:16:36.371Z", "created_by": { "email": "jdoe@email.com", "full_name": "Jane Doe", "username": "jdoe" }, "status": "open", "updated_at": "2022-05-12T00:27:58.162Z", "updated_by": { "email": "jsmith@email.com", "full_name": "Joe Smith", "username": "jsmith" }, "assignees": [], "connector": { "id": "none", "name": "none", "type": ".none", "fields": null }, "external_service": null } ], "count_open_cases": 1, "count_in_progress_cases":0, "count_closed_cases": 0 }