kibana/docs/api/saved-objects.asciidoc
Court Ewing 5abc2dc738
Documentation for Saved Objects API (#19513)
* Adds documentation for Saved Objects API

Signed-off-by: Tyler Smalley <tyler.smalley@elastic.co>

* [DOCS] Moved Rest APIs in navigation

* docs: revise rest api intro

* docs: revise create object api details

* docs: revise saved object api intro

* docs: revise delete saved object api details

* docs: remove newline character from api response

* docs: get saved object api details

* docs: update saved object api details

* docs: fix title attribute in saved object api examples

* docs: bulk-get saved object api details

* docs: find saved object api details

* docs: add index-pattern to valid types in api

* docs: clarify sending multiple values in api

* docs: note that savedObjects.find is not safe for export
2018-05-30 12:27:48 -04:00

25 lines
899 B
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.
* <<saved-objects-api-get>>
* <<saved-objects-api-bulk-get>>
* <<saved-objects-api-find>>
* <<saved-objects-api-create>>
* <<saved-objects-api-update>>
* <<saved-objects-api-delete>>
include::saved-objects/get.asciidoc[]
include::saved-objects/bulk_get.asciidoc[]
include::saved-objects/find.asciidoc[]
include::saved-objects/create.asciidoc[]
include::saved-objects/update.asciidoc[]
include::saved-objects/delete.asciidoc[]