Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kibana data views API

Data view APIs enable you to manage data views, formerly known as Kibana index patterns.

Kibana data views API is one of 60 APIs that Kibana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include data views. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 15 operations across 9 paths, and defines 17 schemas. It is described by OpenAPI 3.0.3.

Requests are made against a single base URL, https://{kibana_url}.

15 operations 9 paths 17 schemas 2 DELETE4 GET8 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
Base URL
https://localhost:5601/api
Authentication
API Key, HTTP Basic
Contact
Kibana Team
Resource Areas
1

Authentication & Security 2

Kibana data views API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiKeyAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • apiKeyAuth — These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64A…

Paths & Operations 15

Across 9 paths, the API surfaces 15 operations — 2 DELETE, 4 GET, 8 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

data views 15

Data view APIs enable you to manage data views, formerly known as Kibana index patterns.

GET
/api/data_views
Get all data views
getAllDataViewsDefault → 200400
POST
/api/data_views/data_view
Create a data view
createDataViewDefaultw 1 param body → 200400
DELETE
/api/data_views/data_view/{viewId}
Delete a data view
deleteDataViewDefault 2 params → 204404
GET
/api/data_views/data_view/{viewId}
Get a data view
getDataViewDefault 1 param → 200404
POST
/api/data_views/data_view/{viewId}
Update a data view
updateDataViewDefault 2 params body → 200400
POST
/api/data_views/data_view/{viewId}/fields
Update field metadata
updateFieldsMetadataDefault 2 params body → 200400
POST
/api/data_views/data_view/{viewId}/runtime_field
Create a runtime field
createRuntimeFieldDefault 2 params body → 200
PUT
/api/data_views/data_view/{viewId}/runtime_field
Create or update a runtime field
createUpdateRuntimeFieldDefault 2 params body → 200400
DELETE
/api/data_views/data_view/{viewId}/runtime_field/{fieldName}
Delete a runtime field
deleteRuntimeFieldDefault 2 params → 200404
GET
/api/data_views/data_view/{viewId}/runtime_field/{fieldName}
Get a runtime field
getRuntimeFieldDefault 2 params → 200404
POST
/api/data_views/data_view/{viewId}/runtime_field/{fieldName}
Update a runtime field
updateRuntimeFieldDefault 2 params body → 200400
GET
/api/data_views/default
Get the default data view
getDefaultDataViewDefault → 200400
POST
/api/data_views/default
Set the default data view
setDefaultDatailViewDefault 1 param body → 200400
POST
/api/data_views/swap_references
Swap saved object references
swapDataViewsDefault 1 param body → 200
POST
/api/data_views/swap_references/_preview
Preview swap references
previewSwapDataViewsDefault 1 param body → 200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are Data_views_swap_data_view_request_object (6 properties), Data_views_404_response (3 properties), Data_views_400_response (3 properties), Data_views_fieldattrs (3 properties). Each schema is shown below with its type and property counts.

Data_views_runtimefieldmap
object
A map of runtime field definitions by field name.
2 properties 2 required
Data_views_timefieldname
string
The timestamp field name, which you use for time-based data views.
Data_views_typemeta_response
object
When you use rollup indices, contains the field list for the rollup data view API endpoints.
2 properties
Data_views_fieldformats
object
A map of field formats by field name.
Data_views_allownoindex
boolean
Allows the data view saved object to exist before the data is available. Defaults to false.
Data_views_fieldattrs
object
A map of field attributes by field name.
3 properties
Data_views_400_response
object
3 properties 3 required
Data_views_data_view_response_object
object
1 property
Data_views_404_response
object
3 properties
Data_views_title
string
Comma-separated list of data streams, indices, and aliases that you want to search. Supports wildcards ().
Data_views_swap_data_view_request_object
object
6 properties 2 required
Data_views_typemeta
object
When you use rollup indices, contains the field list for the rollup data view API endpoints.
2 properties 2 required
Data_views_type
string
When set to rollup, identifies the rollup data views.
Data_views_create_data_view_request_object
object
2 properties 1 required
Data_views_namespaces
array
An array of space identifiers for sharing the data view between multiple spaces.
Data_views_update_data_view_request_object
object
2 properties 1 required
Data_views_sourcefilters
array
The array of field names you want to filter out in Discover.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kibana-data-views-api-openapi.yml Raw ↑

Other APIs Kibana publishes across the network.

Kibana Actions API
Kibana agent builder API
Kibana alerting API
Kibana APM agent configuration API
Kibana APM agent keys API
Kibana APM annotations API
Kibana APM server schema API
Kibana APM sourcemaps API
Kibana cases API
Kibana connectors API
Kibana Data streams API
Kibana Elastic Agent actions API