* Initial work * Add overwrite and skip support * Cleanup and add tests * Move code into separate files * Remove reduce * New API parameters * Add support to replace references * Add better error handling * Add spaces tests * Fix return type in collectSavedObjects * Apply PR feedback * Update jest tests due to jest version upgrade * Add docs * WIP * Split import routes pt1 * Add tests * Fix broken tests * Update docs and fix broken test * Add successCount to _import endpoint * Make skip by default in resolution API * Update tests for removal of skips * Add back support for skips * Add success count * Add back resolve import conflicts x-pack tests * Remove writev from filter stream * Delete _mock_server.d.ts file * Rename lib/import_saved_objects to lib/import * Filter records at stream level for conflict resolution * Update docs * Add tests to validate documentation * Return 200 instead of other code for errors, include errors array * Change [] to {} * Apply PR feedback * Fix import object limit to not return 500 * Change some wording in the docs * Fix status code * Apply PR feedback pt2 * Lower maxImportPayloadBytes to 10MB * Add unknown type tests for import * Add unknown type tests for resolve_import_conflicts * Fix tslint issues
35 lines
1.3 KiB
Plaintext
35 lines
1.3 KiB
Plaintext
[[saved-objects-api]]
|
|
== Saved Objects API
|
|
|
|
The saved objects API allows people to manage Kibana saved objects, including
|
|
but not limited to dashboards, visualizations, and index patterns.
|
|
|
|
Traditionally, developers would perform this level of integration by writing
|
|
documents directly to the `.kibana` index. *Do not do this!* Writing directly
|
|
to the `.kibana` index is not safe and it _will_ result in corrupted data that
|
|
permanently breaks Kibana in a future version.
|
|
|
|
NOTE: You cannot access these endpoints via the Console in Kibana.
|
|
|
|
* <<saved-objects-api-get>>
|
|
* <<saved-objects-api-bulk-get>>
|
|
* <<saved-objects-api-find>>
|
|
* <<saved-objects-api-create>>
|
|
* <<saved-objects-api-bulk-create>>
|
|
* <<saved-objects-api-update>>
|
|
* <<saved-objects-api-delete>>
|
|
* <<saved-objects-api-export>>
|
|
* <<saved-objects-api-import>>
|
|
* <<saved-objects-api-resolve-import-conflicts>>
|
|
|
|
include::saved-objects/get.asciidoc[]
|
|
include::saved-objects/bulk_get.asciidoc[]
|
|
include::saved-objects/find.asciidoc[]
|
|
include::saved-objects/create.asciidoc[]
|
|
include::saved-objects/bulk_create.asciidoc[]
|
|
include::saved-objects/update.asciidoc[]
|
|
include::saved-objects/delete.asciidoc[]
|
|
include::saved-objects/export.asciidoc[]
|
|
include::saved-objects/import.asciidoc[]
|
|
include::saved-objects/resolve_import_conflicts.asciidoc[]
|