Update runtime field API

Deprecated in 8.0.0.

[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. Update an existing runtime field

Request

edit

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 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.
name: (Required, string) The name of the runtime field you want to update.

Request body

edit

runtimeField: (Required, object) The runtime field definition object.

You can update following fields:

type
script

Examples

edit

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": {...}
}

« Upsert runtime field API Delete runtime field API »