IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Data views API Create data view API »
Elastic Docs ›Kibana Guide [8.1] ›REST API ›Data views API

Get data view API

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Get data view API

edit

[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. Retrieve a single data view by ID.

Request

edit

GET <kibana host>:<port>/api/index_patterns/index_pattern/<id>

GET <kibana host>:<port>/s/<space_id>/api/index_patterns/index_pattern/<id>

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.
id
(Required, string) The ID of the data view you want to retrieve.

Response code

edit
200
Indicates a successful call.
404
The specified data view and ID doesn’t exist.

Example

edit

Retrieve the data view object with the my-pattern ID:

$ curl -X GET api/index_patterns/index_pattern/my-pattern

The API returns a data view object:

{
    "index_pattern": {
        "id": "my-pattern",
        "version": "...",
        "title": "...",
        "type": "...",
        "timeFieldName": "...",
        "sourceFilters": [],
        "fields": {},
        "typeMeta": {},
        "fieldFormats": {},
        "fieldAttrs": {},
        "runtimeFieldMap" {},
        "allowNoIndex: "..."
    }
}
« Data views API Create data view API »