Pin/unpin an event
https://{kibana_url}
- PATCH /api/pinned_event
- PATCH /s/{space_id}/api/pinned_event
Refer to Spaces for more information.
Pin/unpin an event to/from an existing Timeline.
Request
The pinned event to add or unpin, along with additional metadata.
-
eventIdstringrequired -
The
_idof the associated event for this pinned event. -
pinnedEventIdstringnullable -
The
savedObjectIdof the pinned event you want to unpin. -
timelineIdstringrequired -
The
savedObjectIdof the timeline that you want this pinned event unpinned from.
Response
Indicates a successful call.
-
creatednumbernullable -
The time the pinned event was created, using a 13-digit Epoch timestamp.
-
createdBystringnullable -
The user who created the pinned event.
-
updatednumbernullable -
The last time the pinned event was updated, using a 13-digit Epoch timestamp
-
updatedBystringnullable -
The user who last updated the pinned event
-
eventIdstringrequired -
The
_idof the associated event for this pinned event. -
timelineIdstringrequired -
The
savedObjectIdof the timeline that this pinned event is associated with -
pinnedEventIdstringrequired -
The
savedObjectIdof this pinned event -
versionstringrequired -
The version of this pinned event
-
unpinnedbooleanrequired -
Indicates whether the event was successfully unpinned