IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Create runtime field API
editCreate runtime field API
editDeprecated in 8.0.0.
Use Create runtime field instead.
[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Create a runtime field
Request
editPOST <kibana host>:<port>/api/index_patterns/index_pattern/<index_pattern_id>/runtime_field
POST <kibana host>:<port>/s/<space_id>/api/index_patterns/index_pattern/<index_pattern_id>/runtime_field
Path parameters
edit-
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.
Request body
edit-
name
- (Required, string) The name for a runtime field.
-
runtimeField
- (Required, object) The runtime field definition object.
Examples
editCreate a runtime field on an index pattern:
$ curl -X POST api/index_patterns/index_pattern/<index_pattern_id>/runtime_field { "name": "runtimeFoo", "runtimeField": { "type": "long", "script": { "source": "emit(doc["foo"].value)" } } }
The API returns created runtime field object and update index pattern object:
{ "index_pattern": {...}, "field": {...} }