Favorite a Timeline or Timeline template Beta

PATCH /api/timeline/_favorite

Favorite a Timeline or Timeline template for the current user.

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

Body Required

The required fields used to favorite a (template) Timeline.

Responses

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

    Indicates the favorite status was successfully updated.

    Hide response attribute Show response attribute object
  • 403 application:json; Elastic-Api-Version=2023-10-31

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

    Hide response attributes Show response attributes object
PATCH /api/timeline/_favorite
curl \
 -X PATCH https://localhost:5601/api/timeline/_favorite \
 -H "Content-Type: application/json; Elastic-Api-Version=2023-10-31"
Request examples
{
  "templateTimelineId": "string",
  "templateTimelineVersion": 42.0,
  "timelineId": "string",
  "timelineType": "default"
}
Response examples (200)
{
  "data": {
    "persistFavorite": {
      "code": 42.0,
      "favorite": [
        {
          "favoriteDate": 42.0,
          "fullName": "string",
          "userName": "string"
        }
      ],
      "message": "string",
      "savedObjectId": "string",
      "templateTimelineId": "string",
      "templateTimelineVersion": 42.0,
      "timelineType": "default",
      "version": "string"
    }
  }
}
Response examples (403)
{
  "body": "string",
  "statusCode": 42.0
}