Create a runtime field

Base URL: https://{kibana_url}

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

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.
viewId string required: An identifier for the data view.; Example: ff959d40-b880-11e8-a6d9-e546fe2bba5f

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.

Response

Indicates a successful call.

application/json

Response Type: object

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
{
  "name": "runtimeFoo",
  "runtimeField": {
    "script": {
      "source": "emit(doc[\u0022foo\u0022].value)"
    },
    "type": "long"
  }
}

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

{}

Generated from the API spec

Path parameters

Header parameters

Request body { }

Response

Request body