Pin an event | Kibana Serverless API documentation

Pin an event Beta

PATCH /api/pinned_event

Api key auth

Pin an event to an existing Timeline.

application/json

Body Required

The pinned event to add or update, along with additional metadata.

eventId string Required
pinnedEventId string | null
timelineId string Required

Responses

200 application/json

Indicates the event was successfully pinned to the Timeline.
One of:
Security_Timeline_API_PinnedEvent object object-2 object
Hide attributes Show attributes

created number | null

createdBy string | null

eventId string Required

timelineId string Required

updated number | null

updatedBy string | null

pinnedEventId string Required

version string Required
Hide attribute Show attribute

unpinned boolean Required

PATCH /api/pinned_event

curl \
 --request PATCH https://<KIBANA_URL>/api/pinned_event \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"eventId":"string","pinnedEventId":"string","timelineId":"string"}'

Request examples

{
  "eventId": "string",
  "pinnedEventId": "string",
  "timelineId": "string"
}

Response examples (200)

{
  "created": 42.0,
  "createdBy": "string",
  "eventId": "string",
  "timelineId": "string",
  "updated": 42.0,
  "updatedBy": "string",
  "pinnedEventId": "string",
  "version": "string"
}

{
  "unpinned": true
}