This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
« Update index pattern fields API Create runtime field API »
Elastic Docs ›Kibana Guide [8.x] ›REST API ›Index patterns APIs

Get runtime field API

edit

Get runtime field API

edit

Deprecated in 8.0.0.

Use the data views API instead.

[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Get a runtime field

Request

edit

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 parameters

edit
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.

Example

edit

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": {
        ...
    }
}
« Update index pattern fields API Create runtime field API »