Get case information

Server: https://{kibana_url}

GET /api/cases/{caseId}
GET /s/{space_id}/api/cases/{caseId}

Refer to Spaces for more information.

You 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

caseId string required: The identifier for the case. To retrieve case IDs, use the find cases API. All non-ASCII characters must be URL encoded.

Query Parameters

includeComments boolean · default: true deprecated: Deprecated in 8.1.0. This parameter is deprecated and will be removed in a future release. It determines whether case comments are returned.

Responses

Indicates a successful call.

application/json

Authorization information is missing or invalid.

application/json

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET /api/cases/{caseId}

curl Shell

curl -X GET "https://{kibana_url}/api/cases/{caseId}"

Response

{
  "assignees": [
    {
      "uid": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0"
    }
  ],
  "category": "null",
  "closed_at": "null",
  "closed_by": "null",
  "comments": [
    {
      "comment": "A new comment",
      "created_at": "2023-10-13T15:40:32.335Z",
      "created_by": {
        "email": "null",
        "full_name": "null",
        "profile_uid": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0",
        "username": "elastic"
      },
      "id": "2134c1d0-02c2-11ed-85f2-4f7c222ca2fa",
      "owner": "cases",
      "pushed_at": "null",
      "pushed_by": "null",
      "type": "user",
      "updated_at": "null",
      "updated_by": "null",
      "version": "WzM3LDFd"
    }
  ],
  "connector": {
    "fields": "null",
    "id": "none",
    "name": "none",
    "type": ".none"
  },
  "created_at": "2023-10-13T15:33:50.604Z",
  "created_by": {
    "email": "null",
    "full_name": "null",
    "profile_uid": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0",
    "username": "elastic"
  },
  "customFields": [
    {
      "key": "d312efda-ec2b-42ec-9e2c-84981795c581",
      "type": "text",
      "value": "My field value"
    },
    {
      "key": "fcc6840d-eb14-42df-8aaf-232201a705ec",
      "type": "toggle",
      "value": "null"
    }
  ],
  "description": "A case description",
  "duration": "null",
  "external_service": "null",
  "id": "31cdada0-02c1-11ed-85f2-4f7c222ca2fa",
  "owner": "cases",
  "settings": {
    "syncAlerts": true
  },
  "severity": "low",
  "status": "open",
  "tags": [
    "tag 1"
  ],
  "title": "Case title 1",
  "totalAlerts": 0,
  "totalComment": 1,
  "updated_at": "2023-10-13T15:40:32.335Z",
  "updated_by": {
    "email": "null",
    "full_name": "null",
    "profile_uid": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0",
    "username": "elastic"
  },
  "version": "WzM2LDFd"
}