IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Get case API
editGet case API
editReturns information about a case.
For the most up-to-date API details, refer to the open API specification.
Request
editGET <kibana host>:<port>/api/cases/<case ID>
GET <kibana host>:<port>/s/<space_id>/api/cases/<case ID>
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 case you’re seeking.
Path parameters
edit-
<case_id> - (Required, string) An identifier for the case to retrieve. Use Find cases to retrieve case IDs.
-
<space_id> - (Optional, string) An identifier for the space. If it is not specified, the default space is used.
Query parameters
edit-
includeComments -
(Optional, boolean) Determines whether case comments are returned. Defaults to
true. [8.1.0] Deprecated in 8.1.0. TheincludeCommentsquery parameter is deprecated and will be removed in a future release.
Response codes
edit-
200 - Indicates a successful call.
Examples
editReturns case ID 31cdada0-02c1-11ed-85f2-4f7c222ca2fa:
GET api/cases/31cdada0-02c1-11ed-85f2-4f7c222ca2fa
The API returns a JSON object with the retrieved case. For example:
{
"id":"31cdada0-02c1-11ed-85f2-4f7c222ca2fa",
"version":"WzM2LDFd",
"comments":[{
"id":"2134c1d0-02c2-11ed-85f2-4f7c222ca2fa",
"version":"WzM3LDFd",
"type":"user",
"owner":"cases",
"comment":"A new comment",
"created_at":"2022-07-13T15:40:32.335Z",
"created_by":{"email":null,"full_name":null,"username":"elastic"},
"pushed_at":null,
"pushed_by":null,
"updated_at":null,
"updated_by":null
}],
"totalComment":1,
"totalAlerts":0,
"title":"Case title 1",
"tags":["tag 1"],
"settings":{"syncAlerts":true},
"owner":"cases",
"description":"A case description",
"duration":null,
"severity":"low",
"closed_at":null,
"closed_by":null,
"created_at":"2022-07-13T15:33:50.604Z",
"created_by":{"username":"elastic","email":null,"full_name":null},
"status":"open",
"updated_at":"2022-07-13T15:40:32.335Z",
"updated_by":{"full_name":null,"email":null,"username":"elastic"},
"assignees":[{"uid":"u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0"}],
"connector":{"id":"none","name":"none","type":".none","fields":null},
"external_service":null
}