Add or update a note | Kibana Serverless API

Add or update a note Beta

PATCH /api/note

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

application/json; Elastic-Api-Version=2023-10-31

Body Required

The note to add or update, along with additional metadata.

eventDataView string | null
eventIngested string | null
eventTimestamp string | null
note object Required

Additional properties are allowed.
Hide note attributes Show note attributes object
- created number | null
- createdBy string | null
- eventId string | null
- note string | null
- timelineId string Required
- updated number | null
- updatedBy string | null
noteId string | null
overrideOwner boolean | null
version string | null

Responses

200 application/json; Elastic-Api-Version=2023-10-31

Indicates the note was successfully created.
Hide response attribute Show response attribute object
- data object Required
  
  Additional properties are allowed.
  
  Hide data attribute Show data attribute object
  
  persistNote object Required
  
  Additional properties are allowed.
  
  Hide persistNote attributes Show persistNote attributes object
  
  code number Required
  
  message string Required
  
  note object Required
  
  Additional properties are allowed.
  
  Hide note attributes Show note attributes object
  
  created number | null
  
  createdBy string | null
  
  eventId string | null
  
  note string | null
  
  timelineId string Required
  
  updated number | null
  
  updatedBy string | null
  
  noteId string Required
  
  version string Required

PATCH /api/note

curl \
 -X PATCH https://localhost:5601/api/note \
 -H "Content-Type: application/json; Elastic-Api-Version=2023-10-31"

Request examples

{
  "eventDataView": "string",
  "eventIngested": "string",
  "eventTimestamp": "string",
  "note": {
    "created": 42.0,
    "createdBy": "string",
    "eventId": "string",
    "note": "string",
    "timelineId": "string",
    "updated": 42.0,
    "updatedBy": "string"
  },
  "noteId": "string",
  "overrideOwner": true,
  "version": "string"
}

Response examples (200)

{
  "data": {
    "persistNote": {
      "code": 42.0,
      "message": "string",
      "note": {
        "created": 42.0,
        "createdBy": "string",
        "eventId": "string",
        "note": "string",
        "timelineId": "string",
        "updated": 42.0,
        "updatedBy": "string",
        "noteId": "string",
        "version": "string"
      }
    }
  }
}