Get Timelines or Timeline templates

Base URL: https://{kibana_url}

GET /api/timelines

Get a list of all saved Timelines or Timeline templates.

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>

Query parameters

Responses

Indicates a successful call.

application/json

customTemplateTimelineCount number: The amount of custom Timeline templates in the results
defaultTimelineCount number: The amount of default type Timelines in the results
elasticTemplateTimelineCount number: The amount of Elastic's Timeline templates in the results
favoriteCount number: The amount of favorited Timelines
templateTimelineCount number: The amount of Timeline templates in the results
timeline object[] required
totalCount number required: The total amount of results

Bad Request response.

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/timelines

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/timelines" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

{
  "customTemplateTimelineCount": 0,
  "defaultTimelineCount": 1,
  "elasticTemplateTimelineCount": 0,
  "favoriteCount": 0,
  "templateTimelineCount": 0,
  "timeline": [
    {
      "savedObjectId": "15c1929b-0af7-42bd-85a8-56e234cc7c4e",
      "status": "active",
      "timelineType": "default",
      "title": "Phishing investigation",
      "updated": 1741344876825,
      "version": "WzE0LDFd"
    }
  ],
  "totalCount": 1
}

{
  "body": "get timeline error",
  "statusCode": 400
}