Update a runtime field

Base URL: https://{kibana_url}

POST /api/data_views/data_view/{viewId}/runtime_field/{fieldName}
POST /s/{space_id}/api/data_views/data_view/{viewId}/runtime_field/{fieldName}

Auth

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.
fieldName string required: The name of the runtime field.; Example: hour_of_day
viewId string required: An identifier for the data view.; Example: ff959d40-b880-11e8-a6d9-e546fe2bba5f

Request body

runtimeField object required

The runtime field definition object.

You can update following fields:

type
script

Responses

200

Indicates a successful call.

Bad request

application/json

error string required
message string required
statusCode number required

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/data_views/data_view/ff959d40-b880-11e8-a6d9-e546fe2bba5f/runtime_field/hour_of_day
{
  "runtimeField": {
    "script": {
      "source": "emit(doc[\u0022bar\u0022].value)"
    }
  }
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/data_views/data_view/ff959d40-b880-11e8-a6d9-e546fe2bba5f/runtime_field/hour_of_day" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "runtimeField": {
      "script": {
        "source": "emit(doc[\u0022bar\u0022].value)"
      }
    }
  }'

Generated from the API spec

Response

No body

{
  "error": "Bad Request",
  "message": "string",
  "statusCode": 400
}

Generated from the API spec

Path parameters

Request body { }

Responses

Request body