IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Set default data view API
editSet default 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.
Set a default data view ID. Kibana UI will use the default data view unless user picks a different one.
The API doesn’t validate if given data_view_id
is a valid id.
For the most up-to-date API details, refer to the open API specification.
Request
editPOST <kibana host>:<port>/api/data_views/default
POST <kibana host>:<port>/s/<space_id>/api/data_views/default
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.
Request body
edit-
data_view_id
-
(Required,
string
ornull
) Sets a default data view id. Usenull
to unset a default data view. -
force
-
(Optional, boolean) Updates existing default data view id. The default is
false
.
Response code
edit-
200
- Indicates a successful call.
Example
editSet the default data view id if none is set:
$ curl -X POST api/data_views/default { "data_view_id": "..." }
Upsert the default data view:
$ curl -X POST api/data_views/default { "data_view_id": "...", "force": true }
Unset the default data view:
$ curl -X POST api/data_views/default { "data_view_id": null, "force": true }
The API returns:
{ "acknowledged": true }