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.
Data views API
editData views APIedit
Manage data views, formerly known as Kibana index patterns.
Do not write documents directly to the .kibana index. When you write directly
to the .kibana index, the data becomes corrupted and permanently breaks future Kibana versions.
Use the data views APIs for managing data views instead of lower-level saved objects API.
The following data views APIs are available:
-
Data views
- Get all data views API to retrieve a list of data views
- Get data view API to retrieve a single data view
- Create data view API to create data view
- Update data view API to partially updated data view
- Delete data view API to delete a data view
- Data view swap references preview API to preview a data view reference swap
- Data view swap references API to perform a data view reference swap
-
Default data views
- Get default data view API to retrieve a default data view
- Set default data view API to set a default data view
-
Fields
-
Update data view field to change field metadata, such as
count,customLabelandformat
-
Update data view field to change field metadata, such as
-
Runtime fields
- Get runtime field API to retrieve a runtime field
- Create runtime field API to create a runtime field
- Upsert runtime field API to create or update a runtime field
- Update runtime field API to partially update an existing runtime field
- Delete runtime field API to delete a runtime field