- Kibana Guide: other versions:
- What is Kibana?
- What’s new in 8.3
- Kibana concepts
- Quick start
- Set up
- Install Kibana
- Configure Kibana
- Alerting and action settings
- APM settings
- Banners settings
- Enterprise Search settings
- Fleet settings
- i18n settings
- Logging settings
- Logs settings
- Metrics settings
- Monitoring settings
- Reporting settings
- Search sessions settings
- Secure settings
- Security settings
- Spaces settings
- Task Manager settings
- Telemetry settings
- URL drilldown settings
- Start and stop Kibana
- Access Kibana
- Securing access to Kibana
- Add data
- Upgrade Kibana
- Configure security
- Configure reporting
- Configure logging
- Configure monitoring
- Command line tools
- Production considerations
- Discover
- Dashboard and visualizations
- Canvas
- Maps
- Build a map to compare metrics by country or region
- Track, visualize, and alert on assets in real time
- Map custom regions with reverse geocoding
- Heat map layer
- Tile layer
- Vector layer
- Plot big data
- Search geographic data
- Configure map settings
- Connect to Elastic Maps Service
- Import geospatial data
- Troubleshoot
- Reporting and sharing
- Machine learning
- Graph
- Alerting
- Observability
- APM
- Security
- Dev Tools
- Fleet
- Osquery
- Stack Monitoring
- Stack Management
- REST API
- Get features API
- Kibana spaces APIs
- Kibana role management APIs
- User session management APIs
- Saved objects APIs
- Data views API
- Index patterns APIs
- Alerting APIs
- Action and connector APIs
- Cases APIs
- Import and export dashboard APIs
- Logstash configuration management APIs
- Machine learning APIs
- Short URLs APIs
- Get Task Manager health
- Upgrade assistant APIs
- Kibana plugins
- Troubleshooting
- Accessibility
- Release notes
- Developer guide
Set default index pattern API
editSet default index pattern API
editDeprecated 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 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 }