Update runtime field APIedit

[experimental] This functionality is experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features. Update an existing runtime field

Requestedit

POST <kibana host>:<port>/api/index_patterns/index_pattern/<index_pattern_id>/runtime_field/<name>

POST <kibana host>:<port>/s/<space_id>/api/index_patterns/index_pattern/<index_pattern_id>/runtime_field/<name>

Path parametersedit

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.
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 an index pattern:

$ curl -X POST api/index_patterns/index_pattern/<index_pattern_id>/runtime_field/<runtime_field_name>
{
  "runtimeField": {
     "script": {
        "source": "emit(doc["bar"].value)"
      }
  }
}

The API returns updated runtime field object and updated index pattern object:

{
    "index_pattern": {...},
    "field": {...}
}