Get runtime field APIedit
Deprecated in 8.0.0.
Use Get runtime field instead.
[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Get a runtime field
Requestedit
GET <kibana host>:<port>/api/index_patterns/index_pattern/<index_pattern_id>/runtime_field/<name>
GET <kibana host>:<port>/s/<space_id>/api/index_patterns/index_pattern/<index_pattern_id>/runtime_field/<name>
Path parametersedit
-
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.
-
name
- (Required, string) The name of the runtime field you want to retrieve.
Exampleedit
Retrieve a runtime field named foo
of index pattern with the my-pattern
ID:
$ curl -X GET api/index_patterns/index_pattern/my-pattern/runtime_field/foo
The API returns a runtime field
object, and a runtimeField
definition object:
{ "field": { ... }, "runtimeField": { ... } }