IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Update Timeline or Timeline template Pin an event to an existing Timeline »
Elastic Docs ›Elastic Security [8.3] ›Elastic Security APIs ›Timeline API

Add a note to an existing Timeline

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Add a note to an existing Timeline

edit

Add a note to an existing Timeline or Timeline event.

Request URL

edit

PATCH <kibana host>:<port>/api/note

Request body

edit

A JSON object defining the note content to be added.

Name Type Description Required

note

eventNote

A note added to a specific Timeline event

  • timelineId: The savedObjectId of an existing Timeline the note is linked to
  • eventId: Required if the note is linked to a specific Timeline event.
  • note: Note content

Yes

Example requests

edit

Example 1

Add a note to an existing Timeline event:

PATCH api/note
{
  "note":{
    "eventId":"dDaPFXkB-qWtr5vqlN9o",
    "note":"My note",
    "timelineId":"b2c103b0-a79d-11eb-9dce-0f3114099868"
  }
}

Example 2

Add a note to an existing Timeline:

PATCH api/note
{
  "note":{
    "note":"My note",
    "timelineId":"b2c103b0-a79d-11eb-9dce-0f3114099868"
  }
}
« Update Timeline or Timeline template Pin an event to an existing Timeline »