Resolve Import Errorsedit
This functionality is experimental and may be changed or removed completely in a future release.
The resolve import errors API enables you to resolve errors given by the import API by either retrying certain saved objects, overwriting specific saved objects or changing references to different saved objects.
Note: You cannot access this endpoint via the Console in Kibana.
Requestedit
POST /api/saved_objects/_resolve_import_errors
Request bodyedit
The request body must be of type multipart/form-data.
-
file - The same file given to the import API.
-
retries -
(array) A list of
type,id,replaceReferencesandoverwriteobjects to retry importing. The propertyreplaceReferencesis a list oftype,fromandtoused to change the object’s references.
Response bodyedit
The response body will have a top level success property that indicates
if resolving errors was successful or not as well as a successCount indicating how many records are successfully resolved.
In the scenario resolving errors wasn’t successful, a top level errors array will contain the objects that failed to be resolved.
Examplesedit
The following example retries importing a dashboard.
$ curl -X POST "localhost:5601/api/saved_objects/_resolve_import_errors" -H "kbn-xsrf: true" --form file=@file.ndjson --form retries='[{"type":"dashboard","id":"my-dashboard"}]'
The file.ndjson file would contain the following.
{"type":"dashboard","id":"my-dashboard","attributes":{"title":"Look at my dashboard"}}
A successful call returns a response code of 200 and a response body
containing a JSON structure similar to the following example:
{
"success": true,
"successCount": 1
}
The following example resolves errors for a dashboard. This will cause the dashboard to overwrite the existing saved object.
$ curl -X POST "localhost:5601/api/saved_objects/_resolve_import_errors" -H "kbn-xsrf: true" --form file=@file.ndjson --form retries='[{"type":"dashboard","id":"my-dashboard","overwrite":true}]'
The file.ndjson file would contain the following.
{"type":"index-pattern","id":"my-pattern","attributes":{"title":"my-pattern-*"}}
{"type":"dashboard","id":"my-dashboard","attributes":{"title":"Look at my dashboard"}}
A successful call returns a response code of 200 and a response body
containing a JSON structure similar to the following example:
{
"success": true,
"successCount": 1
}
The following example resolves errors for a visualization by replacing the index pattern to another.
$ curl -X POST "localhost:5601/api/saved_objects/_resolve_import_errors" -H "kbn-xsrf: true" --form file=@file.ndjson --form retries='[{"type":"visualization","id":"my-vis","replaceReferences":[{"type":"index-pattern","from":"missing","to":"existing"}]}]'
The file.ndjson file would contain the following.
{"type":"visualization","id":"my-vis","attributes":{"title":"Look at my visualization"},"references":[{"name":"ref_0","type":"index-pattern","id":"missing"}]}
A successful call returns a response code of 200 and a response body
containing a JSON structure similar to the following example:
{
"success": true,
"successCount": 1
}