Create or update a runtime field

Base URL: https://{kibana_url}

PUT /api/data_views/data_view/{viewId}/runtime_field
PUT /s/{space_id}/api/data_views/data_view/{viewId}/runtime_field

Auth

Create or update a runtime field for a data view. If the runtime field already exists, it is replaced with the new definition.

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.
viewId string required: The ID of the data view fields you want to update.

Header parameters

kbn-xsrf string required: Cross-site request forgery protection

Request body

name string required: The name for a runtime field.
runtimeField object required: The runtime field definition object.

Responses

Indicates a successful call.

application/json

data_view object
fields object[]

Bad request

application/json

error string required
message string required
statusCode number required

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

PUT kbn://api/data_views/data_view/{viewId}/runtime_field
{"name":"hour_of_day","runtimeField":{"type":"long","script":{"source":"emit(doc['timestamp'].value.getHour())"}}}

curl Shell

curl \
  -X PUT "${KIBANA_URL}/api/data_views/data_view/${DATA_VIEW_ID}/runtime_field" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{"name":"hour_of_day","runtimeField":{"type":"long","script":{"source":"emit(doc['"'"'timestamp'"'"'].value.getHour())"}}}'

Response

No example

{
  "error": "Bad Request",
  "message": "[request body.data_view.title]: expected value of type [string] but got [undefined]",
  "statusCode": 400
}

Request Console 1 / 2 languages

Create a long-type runtime field that emits a value derived from the foo source field.