Find case comments

Base URL: https://{kibana_url}

GET /api/cases/{caseId}/comments/_find

Retrieves a paginated list of comments for a case. 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 cases with the comments you're seeking.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Query parameters

Responses

Indicates a successful call.

application/json

comments object[] required: Paginated list of user comments for the case.
page integer required: The current page index.
per_page integer required: The number of items per page.
total integer required: The total number of comments.

Authorization information is missing or invalid.

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/cases/9c235210-6834-11ea-a78c-6ffb38a34414/comments/_find

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/cases/9c235210-6834-11ea-a78c-6ffb38a34414/comments/_find" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

{
  "comments": [
    {
      "comment": "A new comment",
      "created_at": "2023-10-07T19:32:13.104Z",
      "created_by": {
        "email": "null",
        "full_name": "null",
        "profile_uid": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0",
        "username": "elastic"
      },
      "id": "8048b460-fe2b-11ec-b15d-779a7c8bbcc3",
      "owner": "cases",
      "pushed_at": "null",
      "pushed_by": "null",
      "type": "user",
      "updated_at": "null",
      "updated_by": "null",
      "version": "WzIzLDFd"
    }
  ],
  "page": 1,
  "per_page": 20,
  "total": 1
}

{
  "error": "Unauthorized",
  "message": "Unable to authenticate with the provided credentials.",
  "statusCode": 401
}