Pin/unpin an event

Base URL: https://{kibana_url}

PATCH /api/pinned_event

Pin/unpin an event to/from an existing Timeline.

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 a successful call.

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

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

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

{
  "eventId": "d3a1d35a3e84a81b2f8f3859e064c224cdee1b4bc",
  "pinnedEventId": "10r1929b-0af7-42bd-85a8-56e234f98h2f3",
  "timelineId": "15c1929b-0af7-42bd-85a8-56e234cc7c4e",
  "version": "WzQ2LDFe"
}

Authentication

Request body { }

Response

Request body