f8521c09a4
* 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
63 lines
1.6 KiB
Text
63 lines
1.6 KiB
Text
[[saved-objects-api-update]]
|
|
=== Update Object
|
|
|
|
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
|
|
|
The update saved object API enables you to update the attributes for an
|
|
existing Kibana saved object.
|
|
|
|
==== Request
|
|
|
|
`PUT /api/saved_objects/<type>/<id>`
|
|
|
|
==== Path Parameters
|
|
|
|
`type` (required)::
|
|
(string) Valid options, include: `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`
|
|
|
|
`id` (required)::
|
|
(string) ID of object to update
|
|
|
|
|
|
==== Request Body
|
|
|
|
`attributes` (required)::
|
|
(object) The data to persist
|
|
|
|
|
|
==== Examples
|
|
|
|
The following example updates an existing index pattern object identified as
|
|
`my-pattern` with a different index pattern title.
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
PUT api/saved_objects/index-pattern/my-pattern
|
|
{
|
|
"attributes": {
|
|
"title": "some-other-pattern-*"
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
// KIBANA
|
|
|
|
A successful call returns a response code of `200` and a response body
|
|
containing a JSON structure similar to the following example:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
{
|
|
"id": "my-pattern",
|
|
"type": "index-pattern",
|
|
"version": 2,
|
|
"attributes": {
|
|
"title": "some-other-pattern-*"
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
|
|
==== Known issues
|
|
|
|
1. *Attributes are not validated at update time*. This means you can pass
|
|
arbitrary and ill-formed data into this API that can break Kibana. Make sure
|
|
any data you send to this API is properly formed.
|