2018-05-30 18:27:48 +02:00
|
|
|
[[saved-objects-api]]
|
2019-09-06 18:09:57 +02:00
|
|
|
== Saved objects APIs
|
2018-05-30 18:27:48 +02:00
|
|
|
|
2019-09-06 18:09:57 +02:00
|
|
|
Manage {kib} saved objects, including dashboards, visualizations, index patterns, and more.
|
2018-05-30 18:27:48 +02:00
|
|
|
|
2019-09-06 18:09:57 +02:00
|
|
|
WARNING: Do not write documents directly to the `.kibana` index. When you write directly
|
|
|
|
|
to the `.kibana` index, the data becomes corrupted and permanently breaks future {kib} versions.
|
2018-05-30 18:27:48 +02:00
|
|
|
|
2019-10-16 22:10:40 +02:00
|
|
|
The following saved objects APIs are available:
|
|
|
|
|
|
|
|
|
|
* <<saved-objects-api-get, Get object API>> to retrieve a single {kib} saved object by ID
|
|
|
|
|
|
2021-01-20 23:39:21 +01:00
|
|
|
* <<saved-objects-api-resolve, Resolve object API>> to retrieve a single {kib} saved object by ID, using any legacy URL alias if it exists
|
|
|
|
|
|
2019-10-16 22:10:40 +02:00
|
|
|
* <<saved-objects-api-bulk-get, Bulk get objects API>> to retrieve multiple {kib} saved objects by ID
|
|
|
|
|
|
|
|
|
|
* <<saved-objects-api-find, Find objects API>> to retrieve a paginated set of {kib} saved objects by various conditions
|
|
|
|
|
|
|
|
|
|
* <<saved-objects-api-create, Create saved object API>> to create {kib} saved objects
|
|
|
|
|
|
|
|
|
|
* <<saved-objects-api-bulk-create, Bulk create saved objects API>> to create multiple {kib} saved objects
|
|
|
|
|
|
|
|
|
|
* <<saved-objects-api-update, Update object API>> to update the attributes for existing {kib} saved objects
|
|
|
|
|
|
|
|
|
|
* <<saved-objects-api-delete, Delete object API>> to remove {kib} saved objects
|
|
|
|
|
|
|
|
|
|
* <<saved-objects-api-export, Export objects API>> to retrieve sets of saved objects that you want to import into {kib}
|
|
|
|
|
|
|
|
|
|
* <<saved-objects-api-import, Import objects API>> to create sets of {kib} saved objects from a file created by the export API
|
|
|
|
|
|
|
|
|
|
* <<saved-objects-api-resolve-import-errors, Resolve import errors API>> to resolve errors from the import API
|
2018-05-30 18:27:48 +02:00
|
|
|
|
2020-10-16 18:16:10 +02:00
|
|
|
* <<saved-objects-api-rotate-encryption-key, Rotate encryption key API>> to rotate the encryption key for encrypted saved objects
|
|
|
|
|
|
2018-05-30 18:27:48 +02:00
|
|
|
include::saved-objects/get.asciidoc[]
|
|
|
|
|
include::saved-objects/bulk_get.asciidoc[]
|
|
|
|
|
include::saved-objects/find.asciidoc[]
|
|
|
|
|
include::saved-objects/create.asciidoc[]
|
2018-07-10 15:38:39 +02:00
|
|
|
include::saved-objects/bulk_create.asciidoc[]
|
2018-05-30 18:27:48 +02:00
|
|
|
include::saved-objects/update.asciidoc[]
|
|
|
|
|
include::saved-objects/delete.asciidoc[]
|
2019-03-05 21:42:02 +01:00
|
|
|
include::saved-objects/export.asciidoc[]
|
2019-03-08 19:18:36 +01:00
|
|
|
include::saved-objects/import.asciidoc[]
|
2019-03-13 14:17:18 +01:00
|
|
|
include::saved-objects/resolve_import_errors.asciidoc[]
|
2021-01-20 23:39:21 +01:00
|
|
|
include::saved-objects/resolve.asciidoc[]
|
2020-10-16 18:16:10 +02:00
|
|
|
include::saved-objects/rotate_encryption_key.asciidoc[]
|
