925dfab588
* Clean up * Dashboard export API * More changes * role-management and saved-objects * Clean up * Final clean up * Clean up * Moved labels to appropriate places * Fixed rogue commits
41 lines
1 KiB
Text
41 lines
1 KiB
Text
[[saved-objects-api-delete]]
|
|
=== Delete object API
|
|
++++
|
|
<titleabbrev>Delete object</titleabbrev>
|
|
++++
|
|
|
|
Remove a {kib} saved object.
|
|
|
|
WARNING: Once you delete a saved object, _it cannot be recovered_.
|
|
|
|
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
|
|
|
[[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
|