Install prepackaged Timelines

POST /api/timeline/_prepackaged

Install or update prepackaged Timelines.

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

Body Required

The Timelines to install or update.

Responses

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

    Indicates the installation of prepackaged Timelines was successful.

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

    Indicates the installation of prepackaged Timelines was unsuccessful.

    Hide response attributes Show response attributes object
POST /api/timeline/_prepackaged
curl \
 -X POST https://localhost:5601/api/timeline/_prepackaged \
 -H "Content-Type: application/json; Elastic-Api-Version=2023-10-31"
Request examples
{
  "prepackagedTimelines": [
    {
      "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",
      "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"
        }
      ],
      "savedObjectId": "string",
      "version": "string"
    }
  ],
  "timelinesToInstall": [
    {
      "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",
      "eventNotes": [
        {
          "created": 42.0,
          "createdBy": "string",
          "eventId": "string",
          "note": "string",
          "timelineId": "string",
          "updated": 42.0,
          "updatedBy": "string"
        }
      ],
      "globalNotes": [
        {
          "created": 42.0,
          "createdBy": "string",
          "eventId": "string",
          "note": "string",
          "timelineId": "string",
          "updated": 42.0,
          "updatedBy": "string"
        }
      ],
      "pinnedEventIds": [
        "string"
      ],
      "savedObjectId": "string",
      "version": "string"
    }
  ],
  "timelinesToUpdate": [
    {
      "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",
      "eventNotes": [
        {
          "created": 42.0,
          "createdBy": "string",
          "eventId": "string",
          "note": "string",
          "timelineId": "string",
          "updated": 42.0,
          "updatedBy": "string"
        }
      ],
      "globalNotes": [
        {
          "created": 42.0,
          "createdBy": "string",
          "eventId": "string",
          "note": "string",
          "timelineId": "string",
          "updated": 42.0,
          "updatedBy": "string"
        }
      ],
      "pinnedEventIds": [
        "string"
      ],
      "savedObjectId": "string",
      "version": "string"
    }
  ]
}
Response examples (200)
{
  "errors": [
    {
      "error": {
        "message": "string",
        "status_code": 42.0
      },
      "id": "string"
    }
  ],
  "success": true,
  "success_count": 42.0,
  "timelines_installed": 42.0,
  "timelines_updated": 42.0
}
Response examples (500)
{
  "body": "string",
  "statusCode": 42.0
}