Import saved objects

Base URL: https://{kibana_url}

POST /api/saved_objects/_import

Create sets of Kibana saved objects from a file created by the export API. Saved objects can only be imported into the same version, a newer minor on the same major, or the next major. Tampering with exported data risks introducing unspecified errors and data loss.

Exported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.

Note

The exported saved objects include coreMigrationVersion and typeMigrationVersion metadata. If you store exported saved objects outside of Kibana (for example in NDJSON files) or generate them yourself, you must preserve or include these fields to retain forwards compatibility across Kibana versions.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Bad request.

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn://api/saved_objects/_import?createNewCopies=true

curl Shell

curl \
  -X POST "${KIBANA_URL}/api/saved_objects/_import?createNewCopies=true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  --form file=@file.ndjson

Request

Request example

{
  "file": "file.ndjson"
}

Response

{
  "errors": [],
  "success": true,
  "successCount": 1,
  "successResults": [
    {
      "destinationId": "example-dashboard-1-copy",
      "id": "example-dashboard-1",
      "managed": false,
      "type": "dashboard"
    }
  ]
}

{
  "error": "Bad Request",
  "message": "Invalid file extension .txt",
  "statusCode": 400
}

Import saved objects

Authentication

Query parameters

Header parameters

Request body

Responses