kibana/docs/api/data-views/delete.asciidoc
Matthew Kime 5d8a7920c1
[data views] Add data view REST api docs, keep deprecated equivalents (#123111)
* add data view api docs, keep deprecated equivalents

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-02-02 13:37:16 -06:00

45 lines
1 KiB
Text

[[data-views-api-delete]]
=== Delete data view API
++++
<titleabbrev>Delete data view</titleabbrev>
++++
experimental[] Delete data views.
WARNING: Once you delete a data view, _it cannot be recovered_.
[[data-views-api-delete-request]]
==== Request
`DELETE <kibana host>:<port>/api/data_views/data_view/<id>`
`DELETE <kibana host>:<port>/s/<space_id>/api/data_views/data_view/<id>`
[[data-views-api-delete-path-params]]
==== 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.
`id`::
(Required, string) The ID of the data view you want to delete.
[[data-views-api-delete-response-codes]]
==== Response code
`200`::
Indicates that data view is deleted. Returns an empty response body.
==== Example
Delete a data view object with the `my-view` ID:
[source,sh]
--------------------------------------------------
$ curl -X DELETE api/data_views/data_view/my-view
--------------------------------------------------
// KIBANA