Persists a given users favorite status of a timeline.

PATCH /api/timeline/_favorite

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

Body Required

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

templateTimelineId string | null Required
templateTimelineVersion number | null Required
timelineId string | null Required
timelineType string | null Required

The type of timeline to create. Valid values are default and template.

Values are default or template.

Responses

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

Indicates the favorite status was successfully updated.
Hide response attribute Show response attribute object
- data object Required
  
  Hide data attribute Show data attribute object
  
  persistFavorite object Required
  
  Hide persistFavorite attributes Show persistFavorite attributes object
  
  code number | null
  
  favorite array[object]
  
  Hide favorite attributes Show favorite attributes object
  
  favoriteDate number | null
  
  fullName string | null
  
  userName string | null
  
  message string | null
  
  savedObjectId string Required
  
  templateTimelineId string | null
  
  templateTimelineVersion number | null
  
  timelineType string | null
  
  The type of timeline to create. Valid values are default and template.
  
  Values are default or template.
  
  version string Required
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
- body string
- statusCode number

PATCH /api/timeline/_favorite

curl \
 -X PATCH http://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
}