mirror of
https://github.com/elastic/kibana.git
synced 2025-04-25 02:09:32 -04:00
5d8a7920c1
* add data view api docs, keep deprecated equivalents Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
88 lines
1.9 KiB
Text
88 lines
1.9 KiB
Text
[[data-views-api-default-set]]
|
|
=== Set default data view API
|
|
++++
|
|
<titleabbrev>Set default data view</titleabbrev>
|
|
++++
|
|
|
|
experimental[] 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.
|
|
|
|
|
|
[[data-views-api-default-set-request]]
|
|
==== Request
|
|
|
|
`POST <kibana host>:<port>/api/data_views/default`
|
|
|
|
`POST <kibana host>:<port>/s/<space_id>/api/data_views/default`
|
|
|
|
|
|
[[data-views-api-default-set-params]]
|
|
==== Path parameters
|
|
|
|
`space_id`::
|
|
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
|
|
|
|
|
|
[[data-views-api-default-set-body]]
|
|
==== Request body
|
|
|
|
`data_view_id`:: (Required, `string` or `null`) Sets a default data view id. Use `null` to unset a default data view.
|
|
|
|
`force`:: (Optional, boolean) Updates existing default data view id. The default is `false`.
|
|
|
|
|
|
|
|
[[data-views-api-default-set-codes]]
|
|
==== Response code
|
|
|
|
`200`::
|
|
Indicates a successful call.
|
|
|
|
|
|
[[data-views-api-default-set-example]]
|
|
==== Example
|
|
|
|
Set the default data view id if none is set:
|
|
|
|
[source,sh]
|
|
--------------------------------------------------
|
|
$ curl -X POST api/data_views/default
|
|
{
|
|
"data_view_id": "..."
|
|
}
|
|
--------------------------------------------------
|
|
// KIBANA
|
|
|
|
|
|
Upsert the default data view:
|
|
|
|
[source,sh]
|
|
--------------------------------------------------
|
|
$ curl -X POST api/data_views/default
|
|
{
|
|
"data_view_id": "...",
|
|
"force": true
|
|
}
|
|
--------------------------------------------------
|
|
// KIBANA
|
|
|
|
Unset the default data view:
|
|
|
|
[source,sh]
|
|
--------------------------------------------------
|
|
$ curl -X POST api/data_views/default
|
|
{
|
|
"data_view_id": null,
|
|
"force": true
|
|
}
|
|
--------------------------------------------------
|
|
// KIBANA
|
|
|
|
The API returns:
|
|
|
|
[source,sh]
|
|
--------------------------------------------------
|
|
{
|
|
"acknowledged": true
|
|
}
|
|
--------------------------------------------------
|