Update a data view
https://{kibana_url}
- POST /api/data_views/data_view/{viewId}
- POST /s/{space_id}/api/data_views/data_view/{viewId}
Refer to Spaces for more information.
Update an existing data view. Only the fields provided in the request body are updated.
Path Parameters
-
viewIdstringrequired -
An identifier for the data view.
Request
-
data_viewobjectrequired -
The data view properties you want to update. Only the specified properties are updated in the data view. Unspecified fields stay as they are persisted.
-
allowNoIndexboolean -
Allows the data view saved object to exist before the data is available. Defaults to
false. -
fieldFormatsobject -
A map of field formats by field name.
-
fieldsobject -
namestring -
runtimeFieldMapmap string to object -
sourceFiltersobject -
The array of field names you want to filter out in Discover.
-
valuestringrequired -
timeFieldNamestring -
The timestamp field name, which you use for time-based data views.
-
titlestring -
Comma-separated list of data streams, indices, and aliases that you want to search. Supports wildcards (
*). -
typestring -
When set to
rollup, identifies the rollup data views. -
refresh_fieldsboolean · default: false -
Reloads the data view fields after the data view is updated.
Responses
Indicates a successful call.
-
data_viewobject -
allowNoIndexboolean -
Allows the data view saved object to exist before the data is available. Defaults to
false. -
fieldAttrsmap string to object -
<string> -
countinteger -
Popularity count for the field.
-
customDescriptionstring · max: 300 -
Custom description for the field.
-
customLabelstring -
Custom label for the field.
-
fieldFormatsobject -
A map of field formats by field name.
-
fieldsobject -
idstring -
namestring -
The data view name.
-
namespacesobject -
An array of space identifiers for sharing the data view between multiple spaces.
-
runtimeFieldMapmap string to object -
sourceFiltersobject -
The array of field names you want to filter out in Discover.
-
valuestringrequired -
timeFieldNamestring -
The timestamp field name, which you use for time-based data views.
-
titlestring -
Comma-separated list of data streams, indices, and aliases that you want to search. Supports wildcards (
*). -
typeMeta -
When you use rollup indices, contains the field list for the rollup data view API endpoints.
-
versionstring
Bad request
-
errorstringrequired -
messagestringrequired -
statusCodenumberrequired