Import Timelines

Base URL: https://{kibana_url}

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

Auth

Import 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 import as a readable stream.

file object required
isImmutable enum: Whether the Timeline should be immutable; Values: true false

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

Bad Request response.

application/json

body string: The error message
statusCode number

Not found response.

application/json

body string: The error message
statusCode number

Indicates the import of Timelines was unsuccessful.

application/json

body string: The error message
statusCode number

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/timeline/_import
{
  "file": "{\u0022savedObjectId\u0022:\u002215c1929b-0af7-42bd-85a8-56e234cc7c4e\u0022,\u0022version\u0022:\u0022WzE0LDFd\u0022}\\n",
  "isImmutable": "false"
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/timeline/_import" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "file": "{\u0022savedObjectId\u0022:\u002215c1929b-0af7-42bd-85a8-56e234cc7c4e\u0022,\u0022version\u0022:\u0022WzE0LDFd\u0022}\\n",
    "isImmutable": "false"
  }'

Generated from the API spec

Response

{
  "errors": [],
  "success": true,
  "success_count": 5,
  "timelines_installed": 3,
  "timelines_updated": 2
}

{
  "body": "Invalid file extension",
  "statusCode": 400
}

{
  "body": "Unable to find saved object client",
  "statusCode": 404
}

{
  "body": "Could not import timelines",
  "statusCode": 409
}