Create a Timeline or Timeline template
Create a new Timeline or Timeline template.
Body Required
The required Timeline fields used to create a new Timeline, along with optional fields that will be created if not provided.
-
status string | null
The status of the timeline. Valid values are
active
,draft
, andimmutable
.Values are
active
,draft
, orimmutable
. -
templateTimelineId string | null
-
templateTimelineVersion number | null
-
Additional properties are allowed.
-
timelineId string | null
-
timelineType string | null
The type of timeline to create. Valid values are
default
andtemplate
.Values are
default
ortemplate
. -
version string | null
POST
/api/timeline
curl \
--request POST https://localhost:5601/api/timeline \
--header "Content-Type: application/json" \
--data '{"status":"active","templateTimelineId":"string","templateTimelineVersion":42.0,"timeline":{"columns":[{"aggregatable":true,"category":"string","columnHeaderType":"string","description":"string","example":"string","id":"string","indexes":["string"],"name":"string","placeholder":"string","searchable":true,"type":"string"}],"created":42.0,"createdBy":"string","dataProviders":[{"and":[{"enabled":true,"excluded":true,"id":"string","kqlQuery":"string","name":"string","queryMatch":{"displayField":"string","displayValue":"string","field":"string","operator":"string","value":"string"},"type":"default"}],"enabled":true,"excluded":true,"id":"string","kqlQuery":"string","name":"string","queryMatch":{"displayField":"string","displayValue":"string","field":"string","operator":"string","value":"string"},"type":"default"}],"dataViewId":"string","dateRange":{"end":"string","start":"string"},"description":"string","eqlOptions":{"eventCategoryField":"string","query":"string","size":"string","tiebreakerField":"string","timestampField":"string"},"eventType":"string","excludedRowRendererIds":["alert"],"favorite":[{"favoriteDate":42.0,"fullName":"string","userName":"string"}],"filters":[{"exists":"string","match_all":"string","meta":{"alias":"string","controlledBy":"string","disabled":true,"field":"string","formattedValue":"string","index":"string","key":"string","negate":true,"params":"string","type":"string","value":"string"},"missing":"string","query":"string","range":"string","script":"string"}],"indexNames":["string"],"kqlMode":"string","kqlQuery":{"filterQuery":{"kuery":{"expression":"string","kind":"string"},"serializedQuery":"string"}},"savedQueryId":"string","savedSearchId":"string","sort":{"columnId":"string","columnType":"string","sortDirection":"string"},"status":"active","templateTimelineId":"string","templateTimelineVersion":42.0,"timelineType":"default","title":"string","updated":42.0,"updatedBy":"string"},"timelineId":"string","timelineType":"default","version":"string"}'
Request examples
{
"status": "active",
"templateTimelineId": "string",
"templateTimelineVersion": 42.0,
"timeline": {
"columns": [
{
"aggregatable": true,
"category": "string",
"columnHeaderType": "string",
"description": "string",
"example": "string",
"id": "string",
"indexes": [
"string"
],
"name": "string",
"placeholder": "string",
"searchable": true,
"type": "string"
}
],
"created": 42.0,
"createdBy": "string",
"dataProviders": [
{
"and": [
{
"enabled": true,
"excluded": true,
"id": "string",
"kqlQuery": "string",
"name": "string",
"queryMatch": {
"displayField": "string",
"displayValue": "string",
"field": "string",
"operator": "string",
"value": "string"
},
"type": "default"
}
],
"enabled": true,
"excluded": true,
"id": "string",
"kqlQuery": "string",
"name": "string",
"queryMatch": {
"displayField": "string",
"displayValue": "string",
"field": "string",
"operator": "string",
"value": "string"
},
"type": "default"
}
],
"dataViewId": "string",
"dateRange": {
"end": "string",
"start": "string"
},
"description": "string",
"eqlOptions": {
"eventCategoryField": "string",
"query": "string",
"size": "string",
"tiebreakerField": "string",
"timestampField": "string"
},
"eventType": "string",
"excludedRowRendererIds": [
"alert"
],
"favorite": [
{
"favoriteDate": 42.0,
"fullName": "string",
"userName": "string"
}
],
"filters": [
{
"exists": "string",
"match_all": "string",
"meta": {
"alias": "string",
"controlledBy": "string",
"disabled": true,
"field": "string",
"formattedValue": "string",
"index": "string",
"key": "string",
"negate": true,
"params": "string",
"type": "string",
"value": "string"
},
"missing": "string",
"query": "string",
"range": "string",
"script": "string"
}
],
"indexNames": [
"string"
],
"kqlMode": "string",
"kqlQuery": {
"filterQuery": {
"kuery": {
"expression": "string",
"kind": "string"
},
"serializedQuery": "string"
}
},
"savedQueryId": "string",
"savedSearchId": "string",
"sort": {
"columnId": "string",
"columnType": "string",
"sortDirection": "string"
},
"status": "active",
"templateTimelineId": "string",
"templateTimelineVersion": 42.0,
"timelineType": "default",
"title": "string",
"updated": 42.0,
"updatedBy": "string"
},
"timelineId": "string",
"timelineType": "default",
"version": "string"
}
Response examples (200)
{
"columns": [
{
"aggregatable": true,
"category": "string",
"columnHeaderType": "string",
"description": "string",
"example": "string",
"id": "string",
"indexes": [
"string"
],
"name": "string",
"placeholder": "string",
"searchable": true,
"type": "string"
}
],
"created": 42.0,
"createdBy": "string",
"dataProviders": [
{
"and": [
{
"enabled": true,
"excluded": true,
"id": "string",
"kqlQuery": "string",
"name": "string",
"queryMatch": {
"displayField": "string",
"displayValue": "string",
"field": "string",
"operator": "string",
"value": "string"
},
"type": "default"
}
],
"enabled": true,
"excluded": true,
"id": "string",
"kqlQuery": "string",
"name": "string",
"queryMatch": {
"displayField": "string",
"displayValue": "string",
"field": "string",
"operator": "string",
"value": "string"
},
"type": "default"
}
],
"dataViewId": "string",
"dateRange": {
"end": "string",
"start": "string"
},
"description": "string",
"eqlOptions": {
"eventCategoryField": "string",
"query": "string",
"size": "string",
"tiebreakerField": "string",
"timestampField": "string"
},
"eventType": "string",
"excludedRowRendererIds": [
"alert"
],
"favorite": [
{
"favoriteDate": 42.0,
"fullName": "string",
"userName": "string"
}
],
"filters": [
{
"exists": "string",
"match_all": "string",
"meta": {
"alias": "string",
"controlledBy": "string",
"disabled": true,
"field": "string",
"formattedValue": "string",
"index": "string",
"key": "string",
"negate": true,
"params": "string",
"type": "string",
"value": "string"
},
"missing": "string",
"query": "string",
"range": "string",
"script": "string"
}
],
"indexNames": [
"string"
],
"kqlMode": "string",
"kqlQuery": {
"filterQuery": {
"kuery": {
"expression": "string",
"kind": "string"
},
"serializedQuery": "string"
}
},
"savedQueryId": "string",
"savedSearchId": "string",
"sort": {
"columnId": "string",
"columnType": "string",
"sortDirection": "string"
},
"status": "active",
"templateTimelineId": "string",
"templateTimelineVersion": 42.0,
"timelineType": "default",
"title": "string",
"updated": 42.0,
"updatedBy": "string",
"savedObjectId": "string",
"version": "string",
"eventIdToNoteIds": [
{
"created": 42.0,
"createdBy": "string",
"eventId": "string",
"note": "string",
"timelineId": "string",
"updated": 42.0,
"updatedBy": "string",
"noteId": "string",
"version": "string"
}
],
"noteIds": [
"string"
],
"notes": [
{
"created": 42.0,
"createdBy": "string",
"eventId": "string",
"note": "string",
"timelineId": "string",
"updated": 42.0,
"updatedBy": "string",
"noteId": "string",
"version": "string"
}
],
"pinnedEventIds": [
"string"
],
"pinnedEventsSaveObject": [
{
"created": 42.0,
"createdBy": "string",
"eventId": "string",
"timelineId": "string",
"updated": 42.0,
"updatedBy": "string",
"pinnedEventId": "string",
"version": "string"
}
]
}
Response examples (405)
{
"body": "string",
"statusCode": 42.0
}