Saved objects APIs - Update object - 《Kibana v7.9 Guide》

Update object API

Update object API

[experimental] This functionality is experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features. Update the attributes for existing Kibana saved objects.

Request

PUT <kibana host>:<port>/api/saved_objects/<type>/<id>

PUT <kibana host>:<port>/s/<space_id>/api/saved_objects/<type>/<id>

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

Path parameters

space_id

(Optional, string) An identifier for the space. If space_id is not provided in the URL, the default space is used.

type

(Required, string) Valid options include visualization, dashboard, search, index-pattern, config, and timelion-sheet.

id

(Required, string) The object ID to update.

Request body

attributes

(Required, object) The data to persist.

When you update, attributes are not validated, which allows you to pass arbitrary and ill-formed data into the API and break Kibana. Make sure any data that you send to the API is properly formed.

references

(Optional, array) Objects with name, id, and type properties that describe the other saved objects this object references. To refer to the other saved object, use name in the attributes, but never the id, which automatically updates during migrations or import/export.

Response code

200

Indicates a successful call.

Example

Update an existing index pattern object,my-pattern, with a different title:

$ curl -X PUT api/saved_objects/index-pattern/my-pattern
{
  "attributes": {
    "title": "some-other-pattern-*"
  }
}

The API returns the following:

{
  "id": "my-pattern",
  "type": "index-pattern",
  "version": 2,
  "attributes": {
    "title": "some-other-pattern-*"
  }
}