kibana/docs/api/index-patterns/runtime-fields/delete.asciidoc
Lisa Cawley cf43ba2f27
[DOCS] Remove saved object and data view API pages (#190654)
Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
2024-08-20 17:29:06 +00:00

39 lines
1.2 KiB
Text

[[index-patterns-runtime-field-api-delete]]
=== Delete runtime field API
++++
<titleabbrev>Delete runtime field</titleabbrev>
++++
deprecated::[8.0.0,Use the {api-kibana}/group/endpoint-data-views[data views API]instead.]
experimental[] Delete a runtime field from an index pattern.
[[index-patterns-runtime-field-api-delete-request]]
==== Request
`DELETE <kibana host>:<port>/api/index_patterns/index_pattern/<index_pattern_id>/runtime_field/<name>`
`DELETE <kibana host>:<port>/s/<space_id>/api/index_patterns/index_pattern/<index_pattern_id>/runtime_field/<name>`
[[index-patterns-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.
`index_pattern_id`::
(Required, string) The ID of the index pattern 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 an index pattern:
[source,sh]
--------------------------------------------------
$ curl -X DELETE api/index_patterns/index_pattern/<my-pattern>/runtime_field/<runtime-field-name>
--------------------------------------------------
// KIBANA