* 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
33 lines
1.1 KiB
Plaintext
33 lines
1.1 KiB
Plaintext
[[api]]
|
|
= REST API
|
|
|
|
[partintro]
|
|
--
|
|
Some of the features of Kibana are provided via a REST API, which is ideal for
|
|
people that want to create an integration with Kibana or that want to automate
|
|
certain aspects of configuring and deploying Kibana.
|
|
|
|
Each API in this documentation should be clearly marked as either `stable`,
|
|
`beta`, or `experimental`. If an API is not marked, it should be considered
|
|
`experimental`.
|
|
|
|
What do these labels mean?
|
|
|
|
* *Stable* APIs should be safe to use extensively in production. Any breaking
|
|
changes to these APIs should only occur in major versions and will be
|
|
clearly documented in the breaking changes documentation for that release.
|
|
* *Beta* APIs are on track to become stable, permanent features of Kibana.
|
|
Caution should be exercised in their use since it is possible we'd have to make
|
|
a breaking change to these APIs in a minor version, but we'll avoid this
|
|
wherever possible.
|
|
* *Experimental* APIs are just that - an experiment. An experimental API might
|
|
have breaking changes in any version of Kibana, or it might even be removed
|
|
entirely.
|
|
|
|
[float]
|
|
== APIs
|
|
|
|
* <<saved-objects-api>>
|
|
--
|
|
|
|
include::api/saved-objects.asciidoc[] |