Update Objectedit

Warning

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.

Requestedit

PUT /api/saved_objects/<type>/<id>

Path Parametersedit

type (required)
(string) Valid options, include: visualization, dashboard, search, index-pattern, config, and timelion-sheet
id (required)
(string) ID of object to update

Request Bodyedit

attributes (required)
(object) The data to persist

Examplesedit

The 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 issuesedit

  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.