› ›

Console

edit

Console

edit

This content applies to:

Console lets you interact with Elasticsearch and Kibana serverless APIs from your project.

Requests are made in the left pane, and responses are displayed in the right pane.

To go to Console, find Dev Tools in the navigation menu or use the global search bar.

You can also find Console directly on your Elasticsearch Serverless project pages, where you can expand it from the footer. This Console, called Persistent Console, has the same capabilities and shares the same history as the Console in Dev Tools.

Write requests

edit

Console 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 "${ES_URL}/_search" \
-H "Authorization: ApiKey ${API_KEY}" \
-H "Content-Type: application/json" \
-d'
{
  "query": {
    "match_all": {}
  }
}'

Autocomplete

edit

When you’re typing a command, Console makes context-sensitive suggestions. These suggestions show you the parameters for each API and speed up your typing.

You can configure your preferences for autocomplete in the Console settings.

Comments

edit

You can write comments or temporarily disable parts of a request by using double forward slashes (//) or pound (#) signs to create single-line comments.

# This request searches all of your indices.
GET /_search
{
  // The query parameter indicates query context.
  "query": {
    "match_all": {} // Matches all documents.
  }
}

You can also use a forward slash followed by an asterisk (/*) to mark the beginning of multi-line comments. An asterisk followed by a forward slash (*/) marks the end.

GET /_search
{
  "query": {
    /*"match_all": {
      "boost": 1.2
    }*/
    "match_none": {}
  }
}

Variables

edit

Select Variables to create, edit, and delete variables.

You can refer to these variables in the paths and bodies of your requests. Each variable can be referenced multiple times.

GET ${pathVariable}
{
  "query": {
    "match": {
      "${bodyNameVariable}": "${bodyValueVariable}"
    }
  }
}

By default, variables in the body may be substituted as a boolean, number, array, or object by removing nearby quotes instead of a string with surrounding quotes. Triple quotes overwrite this default behavior and enforce simple replacement as a string.

Auto-formatting

edit

The auto-formatting capability can help you format requests to be more readable. Select one or more requests that you want to format, open the contextual menu, and then select Auto indent.

Keyboard shortcuts

edit

Go to line number: Ctrl/Cmd + L

Auto-indent current request: Ctrl/Cmd + I

Jump to next request end: Ctrl/Cmd + ↓

Jump to previous request end: Ctrl/Cmd + ↑

Open documentation for current request: Ctrl/Cmd + /

Run current request: Ctrl/Cmd + Enter

Apply current or topmost term in autocomplete menu: Enter or Tab

Close autocomplete menu: Esc

Navigate items in autocomplete menu: ↓ + ↑

View API docs

edit

To view the documentation for an API endpoint, select the request, then open the contextual menu and select Open API reference.

Run requests

edit

When you’re ready to submit the request, select the play button.

The result of the request execution is displayed in the response panel, where you can see:

the JSON response
the HTTP status code corresponding to the request
The execution time, in ms.

You can select multiple requests and submit them together. Console executes the requests one by one. Submitting multiple requests is helpful when you’re debugging an issue or trying query combinations in multiple scenarios.

Import and export requests

edit

You can export requests:

to a TXT file, by using the Export requests button. When using this method, all content of the input panel is copied, including comments, requests, and payloads. All of the formatting is preserved and allows you to re-import the file later, or to a different environment, using the Import requests button.

When importing a TXT file containing Console requests, the current content of the input panel is replaced. Export it first if you don’t want to lose it, or find it in the History tab if you already ran the requests.
by copying them individually as curl, JavaScript, or Python. To do this, select a request, then open the contextual menu and select Copy as. When using this action, requests are copied individually to your clipboard. You can save your favorite language to make the copy action faster the next time you use it.

When running copied requests from an external environment, you’ll need to add authentication information to the request.

Get your request history

edit

Console maintains a list of the last 500 requests that you tried to execute. To view them, open the History tab.

You can run a request from your history again by selecting the request and clicking Add and run. If you want to add it back to the Console input panel without running it yet, click Add instead. It is added to the editor at the current cursor position.

Configure Console settings

edit

Go to the Config tab of Console to customize its display, autocomplete, and accessibility settings.

Disable Console

edit

You can disable the persistent console that shows in the footer of your Elasticsearch Serverless project pages. To do that, go to Management > Advanced Settings, and turn off the devTools:enablePersistentConsole setting.

« Dev tools Search Profiler »