Upsert 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. Create or update an existing runtime field

Request

edit

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

PUT <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 new runtime field or a name of an existing runtime field.
runtimeField: (Required, object) The runtime field definition object.

Examples

edit

Create or update an existing runtime field on an index pattern:

$ curl -X PUT 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 or updated runtime field object and updated index pattern object:

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

« Create runtime field API Update runtime field API »