Favorite a Timeline or Timeline template

Base URL: https://{kibana_url}

PATCH /api/timeline/_favorite

Favorite a Timeline or Timeline template for the current user.

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

Responses

Indicates a successful call.

application/json

Indicates the user does not have the required permissions to persist the favorite status.

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

PATCH kbn:/api/timeline/_favorite
{
  "templateTimelineId": "null",
  "templateTimelineVersion": "null",
  "timelineId": "15c1929b-0af7-42bd-85a8-56e234cc7c4e",
  "timelineType": "default"
}

Generated from the API spec

curl Shell

curl -X PATCH "${KIBANA_URL}/api/timeline/_favorite" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "templateTimelineId": "null",
    "templateTimelineVersion": "null",
    "timelineId": "15c1929b-0af7-42bd-85a8-56e234cc7c4e",
    "timelineType": "default"
  }'

Generated from the API spec

Response

{
  "favorite": [
    {
      "favoriteDate": 1741337636741,
      "userName": "elastic"
    }
  ],
  "savedObjectId": "15c1929b-0af7-42bd-85a8-56e234cc7c4e",
  "timelineType": "default",
  "version": "WzE2LDFd"
}

{
  "body": "Forbidden",
  "statusCode": 403
}

Authentication

Request body { }

Responses

Request body