Install prepackaged Timelines

Base URL: https://{kibana_url}

POST /api/timeline/_prepackaged
POST /s/{space_id}/api/timeline/_prepackaged

Auth

Install or update prepackaged Timelines.

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Request body

The Timelines to install or update.

prepackagedTimelines object[] required
timelinesToInstall object[] required
timelinesToUpdate object[] required: Same fields as timelinesToInstall

Responses

Indicates a successful call.

application/json

errors object[]: The list of failed Timeline imports
success boolean: Indicates whether any of the Timelines were successfully imports
success_count number: The amount of successfully imported/updated Timelines
timelines_installed number: The amount of successfully installed Timelines
timelines_updated number: The amount of successfully updated Timelines

Indicates the installation of prepackaged Timelines was unsuccessful.

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/timeline/_prepackaged
{
  "prepackagedTimelines": [],
  "timelinesToInstall": [],
  "timelinesToUpdate": []
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/timeline/_prepackaged" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "prepackagedTimelines": [],
    "timelinesToInstall": [],
    "timelinesToUpdate": []
  }'

Generated from the API spec

Response

{
  "errors": [],
  "success": true,
  "success_count": 10,
  "timelines_installed": 8,
  "timelines_updated": 2
}

{
  "body": "Internal error",
  "statusCode": 500
}