- Kibana Guide: other versions:
- What is Kibana?
- What’s new in 7.17
- Kibana concepts
- Quick start
- Set up
- Install Kibana
- Configure Kibana
- Alerting and action settings
- APM settings
- Banners settings
- Development tools settings
- Graph settings
- Fleet settings
- i18n settings
- Logging settings
- Logs settings
- Metrics settings
- Machine learning settings
- Monitoring settings
- Reporting settings
- Secure settings
- Search sessions 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
- Logging configuration migration
- Configure security
- Configure reporting
- Configure monitoring
- 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
- 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
- Accessibility
- Release notes
- Kibana 7.17.27
- Kibana 7.17.26
- Kibana 7.17.25
- Kibana 7.17.24
- Kibana 7.17.23
- Kibana 7.17.22
- Kibana 7.17.21
- Kibana 7.17.20
- Kibana 7.17.19
- Kibana 7.17.18
- Kibana 7.17.17
- Kibana 7.17.16
- Kibana 7.17.15
- Kibana 7.17.14
- Kibana 7.17.13
- Kibana 7.17.12
- Kibana 7.17.11
- Kibana 7.17.10
- Kibana 7.17.9
- Kibana 7.17.8
- Kibana 7.17.7
- Kibana 7.17.6
- Kibana 7.17.5
- Kibana 7.17.4
- Kibana 7.17.3
- Kibana 7.17.2
- Kibana 7.17.1
- Kibana 7.17.0
- Developer guide
Run Elasticsearch API requests
editRun Elasticsearch API requests
editInteract with the REST API of Elasticsearch with Console. You can:
- Send requests to Elasticsearch and view the responses
- View API documentation
- Get your request history
To get started, open the main menu, click Dev Tools, then click Console.
![Console](dev-tools/console/images/console.png)
You cannot to interact with the REST API of Kibana with the Console.
Write requests
editConsole understands commands in a cURL-like syntax.
For example, the following is a GET
request to the Elasticsearch _search
API.
GET /_search { "query": { "match_all": {} } }
Here is the equivalent command in cURL:
curl -XGET "http://localhost:9200/_search" -d' { "query": { "match_all": {} } }'
When you paste the command into Console, Kibana automatically converts it
to Console syntax. Alternatively, if you want to see Console syntax in cURL,
click the action icon () and select Copy as cURL.
Once copied, the username and password will need to be provided
for the calls to work from external environments.
Autocomplete
editWhen you’re typing a command, Console makes context-sensitive suggestions. These suggestions show you the parameters for each API and speed up your typing. To configure your preferences for autocomplete, go to Settings.
Auto-formatting
editThe auto-formatting
capability can help you format requests. Select one or more requests that you
want to format, click the action icon (),
and then select Auto indent.
For example, you might have a request formatted like this:
![Console close-up](dev-tools/console/images/copy-curl.png)
]
Console adjusts the JSON body of the request to apply the indents.
![Console close-up](dev-tools/console/images/request.png)
If you select Auto indent on a request that is already well formatted, Console collapses the request body to a single line per document. This is helpful when working with the Elasticsearch bulk APIs.
Submit requests
editWhen you’re ready to submit the request to Elasticsearch, click the green triangle.
You can select multiple requests and submit them together. Console sends the requests to Elasticsearch one by one and shows the output in the response pane. Submitting multiple requests is helpful when you’re debugging an issue or trying query combinations in multiple scenarios.
View API docs
editTo view the documentation for an API endpoint, click
the action icon () and select
Open documentation.
Get your request history
editConsole maintains a list of the last 500 requests that Elasticsearch successfully executed. To view your most recent requests, click History. If you select a request and click Apply, Kibana adds it to the editor at the current cursor position.
Configure Console settings
editYou can configure the Console font size, JSON syntax, and autocomplete suggestions in Settings.
![Console Settings](dev-tools/console/images/console-settings.png)
Get keyboard shortcuts
editFor a list of available keyboard shortcuts, click Help.
Disable Console
editIf you don’t want to use Console, you can disable it by setting console.ui.enabled
to false
in your kibana.yml
configuration file. Changing this setting
causes the server to regenerate assets on the next startup,
which might cause a delay before pages start being served.
Disable Console (before 8.0)
edit
[7.16.0]
Deprecated in 7.16.0. In 8.0 and later, this setting will no longer be supported.
If you don’t want to use Console, you can disable it by setting console.enabled
to false
in your kibana.yml
configuration file.
On this page