IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Update Object
editUpdate Object
editThis 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
editPUT /api/saved_objects/<type>/<id>
Path Parameters
edit-
type
(required) -
(string) Valid options, include:
visualization
,dashboard
,search
,index-pattern
,config
, andtimelion-sheet
-
id
(required) - (string) ID of object to update
Request Body
edit-
attributes
(required) - (object) The data to persist
Examples
editThe following example updates an existing index pattern object identified as
my-pattern
with a different index pattern title.
PUT api/saved_objects/index-pattern/my-pattern { "attributes": { "title": "some-other-pattern-*" } }
A successful call returns a response code of 200
and a response body
containing a JSON structure similar to the following example:
{ "id": "my-pattern", "type": "index-pattern", "version": 2, "attributes": { "title": "some-other-pattern-*" } }
Known issues
edit- 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.