Set default index pattern APIedit
Deprecated in 8.0.0.
Use Set default data view instead.
[preview]
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort 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.
Requestedit
POST <kibana host>:<port>/api/index_patterns/default
POST <kibana host>:<port>/s/<space_id>/api/index_patterns/default
Path parametersedit
-
space_id -
(Optional, string) An identifier for the space. If
space_idis not provided in the URL, the default space is used.
Request bodyedit
-
index_pattern_id -
(Required,
stringornull) Sets a default index pattern id. Usenullto unset a default index pattern. -
force -
(Optional, boolean) Updates existing default index pattern id. The default is
false.
Response codeedit
-
200 - Indicates a successful call.
Exampleedit
Set 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
}