mirror of
https://github.com/elastic/kibana.git
synced 2025-04-25 18:27:59 -04:00
af45343bee
* [Index Patterns] Runtime fields CRUD REST API (#101164) Part of index pattern REST API # Conflicts: # docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.md # docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpattern.md * fix bad docs merge
37 lines
1.1 KiB
Text
37 lines
1.1 KiB
Text
[[index-patterns-runtime-field-api-delete]]
|
|
=== Delete runtime field API
|
|
++++
|
|
<titleabbrev>Delete runtime field</titleabbrev>
|
|
++++
|
|
|
|
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
|