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

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

Generated from the API spec

curl Shell

curl -X PUT "${KIBANA_URL}/api/data_views/data_view/${VIEW_ID}/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

{
  "data_view": {},
  "fields": [
    {}
  ]
}

Generated from the API spec

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

Generated from the API spec

Path parameters

Header parameters

Request body { }

Responses

Request body