kibana/docs/api/data-views/runtime-fields/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

39 lines
1.1 KiB
Text

[[data-views-runtime-field-api-delete]]
=== Delete runtime field API
++++
<titleabbrev>Delete runtime field</titleabbrev>
++++
experimental[] Delete a runtime field from a data view.
[[data-views-runtime-field-api-delete-request]]
==== Request
`DELETE <kibana host>:<port>/api/data_views/data_view/<data_view_id>/runtime_field/<name>`
`DELETE <kibana host>:<port>/s/<space_id>/api/data_views/data_view/<data_view_id>/runtime_field/<name>`
[[data-views-runtime-field-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.
`data_view_id`::
(Required, string) The ID of the data view your want to delete a runtime field from.
`name`::
(Required, string) The name of the runtime field you want to delete.
==== Example
Delete a runtime field from a data view:
[source,sh]
--------------------------------------------------
$ curl -X DELETE api/data_views/data_view/<my-view>/runtime_field/<runtime-field-name>
--------------------------------------------------
// KIBANA