kibana/docs/api/saved-objects/delete.asciidoc
2019-09-18 10:54:28 -05:00

39 lines
934 B
Text

[[saved-objects-api-delete]]
=== Delete object API
++++
<titleabbrev>Delete object</titleabbrev>
++++
experimental[] Remove a {kib} saved object.
WARNING: Once you delete a saved object, _it cannot be recovered_.
[[saved-objects-api-delete-request]]
==== Request
`DELETE /api/saved_objects/<type>/<id>`
[[saved-objects-api-delete-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 that you want to remove.
[[saved-objects-api-delete-response-codes]]
==== Response code
`200`::
Indicates a successful call.
==== Examples
Delete an index pattern object with the `my-pattern` ID:
[source,js]
--------------------------------------------------
DELETE api/saved_objects/index-pattern/my-pattern
--------------------------------------------------
// KIBANA