68 lines
1.8 KiB
Text
68 lines
1.8 KiB
Text
[[saved-objects-api-update]]
|
|
=== Update object API
|
|
++++
|
|
<titleabbrev>Update object</titleabbrev>
|
|
++++
|
|
|
|
experimental[] Update the attributes for an existing {kib} saved object.
|
|
|
|
[[saved-objects-api-update-request]]
|
|
==== Request
|
|
|
|
`PUT /api/saved_objects/<type>/<id>`
|
|
|
|
[[saved-objects-api-update-path-params]]
|
|
==== Path Parameters
|
|
|
|
`type`::
|
|
(Required, string) Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`.
|
|
|
|
`id`::
|
|
(Required, string) The object ID to update.
|
|
|
|
[[saved-objects-api-update-request-body]]
|
|
==== Request Body
|
|
|
|
`attributes`::
|
|
(Required, object) The data to persist.
|
|
+
|
|
WARNING: When you update, attributes are not validated, which allows you to pass arbitrary and ill-formed data into the API and break {kib}. 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.
|
|
|
|
[[saved-objects-api-update-errors-codes]]
|
|
==== Response code
|
|
|
|
`200`::
|
|
Indicates a successful call.
|
|
|
|
[[saved-objects-api-update-example]]
|
|
==== Example
|
|
|
|
Update an existing index pattern object,`my-pattern`, with a different title:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
PUT api/saved_objects/index-pattern/my-pattern
|
|
{
|
|
"attributes": {
|
|
"title": "some-other-pattern-*"
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
// KIBANA
|
|
|
|
The API returns the following:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
{
|
|
"id": "my-pattern",
|
|
"type": "index-pattern",
|
|
"version": 2,
|
|
"attributes": {
|
|
"title": "some-other-pattern-*"
|
|
}
|
|
}
|
|
--------------------------------------------------
|