Set default index pattern API
editSet default index pattern API
editDeprecated in 8.0.0.
Use the data views API instead.
[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 index pattern ID. Kibana UI will use default index pattern unless user picks a different one.
The API doesn’t validate if given index_pattern_id
is a valid id.
Request
editPOST <kibana host>:<port>/api/index_patterns/default
POST <kibana host>:<port>/s/<space_id>/api/index_patterns/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-
index_pattern_id
-
(Required,
string
ornull
) Sets a default index pattern id. Usenull
to unset a default index pattern. -
force
-
(Optional, boolean) Updates existing default index pattern id. The default is
false
.
Response code
edit-
200
- Indicates a successful call.
Example
editSet the default index pattern id if none is set:
$ curl -X POST api/index_patterns/default { "index_pattern_id": "..." }
Upsert the default index pattern:
$ curl -X POST api/index_patterns/default { "index_pattern_id": "...", "force": true }
Unset the default index pattern:
$ curl -X POST api/index_patterns/default { "index_pattern_id": null, "force": true }
The API returns:
{ "acknowledged": true }