Add or update a note

Base URL: https://{kibana_url}

PATCH /api/note
PATCH /s/{space_id}/api/note

Refer to Spaces for more information.

Add a note to a Timeline or update an existing note.

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>

Request body

Response

Indicates the note was successfully created.

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

PATCH kbn:/api/note
{
  "note": {
    "timelineId": "15c1929b-0af7-42bd-85a8-56e234cc7c4e"
  }
}

Generated from the API spec

curl Shell

curl -X PATCH "${KIBANA_URL}/api/note" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "note": {
      "timelineId": "15c1929b-0af7-42bd-85a8-56e234cc7c4e"
    }
  }'

Generated from the API spec

Response

No example

Authentication

Request body { }

Response

Request body