This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
Update runtime field API
editUpdate runtime field APIedit
Update an existing runtime field
Requestedit
POST <kibana host>:<port>/api/data_views/data_view/<data_view_id>/runtime_field/<name>
POST <kibana host>:<port>/s/<space_id>/api/data_views/data_view/<data_view_id>/runtime_field/<name>
Path parametersedit
-
space_id -
(Optional, string) An identifier for the space. If
space_idis not provided in the URL, the default space is used. -
data_view_id - (Required, string) The ID of the data view.
-
name - (Required, string) The name of the runtime field you want to update.
Request bodyedit
-
runtimeField - (Required, object) The runtime field definition object.
You can update following fields:
-
type -
script
Examplesedit
Update an existing runtime field on a data view:
$ curl -X POST api/data_views/data_view/<data_view_id>/runtime_field/<runtime_field_name>
{
"runtimeField": {
"script": {
"source": "emit(doc["bar"].value)"
}
}
}
The API returns updated runtime field object array and updated data view object:
{
"data_view": {...},
"fields": [...]
}