Get Timelines or Timeline templates

edit

Get Timelines or Timeline templates.

Console supports only Elasticsearch APIs. Console doesn’t allow interactions with Kibana APIs. You must use curl or another HTTP tool instead. For more information, refer to Run Elasticsearch API requests.

Request URL

edit

GET <kibana host>:<port>/api/timelines

Request params

edit
Name Type Description Required

only_user_favorite

Boolean

Returns only favorite Timelines / Timeline templates if set to true. Default to false

No

page_index

Number

Page number of the result

No

page_size

Number

Items per page in result

No

search

String

The key word of the Timelines / Timeline templates you are searching for

No

sort_field

String

The order you want the result to be arranged. Can be title, description, updated, created

No

sort_order

String

asc or desc

No

status

String

Can be active or immutable. active returns all the custom Timelines / Timeline templates, whereas immutable returns Elastic prebuilt templates

No

timeline_type

String

Use the timeline object’s timelineType field to determine whether a timeline or a Timeline template is created, where:

default returns Timelines, template returns Timeline templates

No

Example requests

edit

Get Timelines:

GET api/timelines?page_size=10&page_index=1&sort_field=updated&sort_order=desc&timeline_type=default