github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Adds Kibana API support to Console (#134111) (#134244)

Browse source 
* [DOCS] Adds Kibana API support to Console

* Update docs/dev-tools/console/console.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
(cherry picked from commit 0d5808a22b)

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
This commit is contained in:
Kibana Machine 2022-06-13 12:20:16 -04:00 • committed by GitHub
parent a588ac3438
commit 57c751ce1a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 19 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

17
docs/dev-tools/console/console.asciidoc
View file

@ -1,9 +1,9 @@
[[console-kibana]]
== Run {es} API requests
== Run API requests
Interact with the REST API of {es} with *Console*. You can:
Interact with the REST APIs of {es} and {kib} with *Console*. With *Console*, you can:
* Send requests to {es} and view the responses
* Send requests and view the responses
* View API documentation
* Get your request history
@ -12,8 +12,6 @@ To get started, open the main menu, click *Dev Tools*, then click *Console*.
[role="screenshot"]
image::dev-tools/console/images/console.png["Console"]
NOTE: **Console** supports only Elasticsearch APIs. You are unable to interact with the {kib} APIs with **Console** and must use curl or another HTTP tool instead.
[float]
[[console-api]]
=== Write requests
@ -43,6 +41,15 @@ curl -XGET "http://localhost:9200/_search" -d'
}'
----------------------------------
Prepend requests to a {kib} API endpoint with `kbn:`
[source,bash]
--------------------------------------------------
`GET kbn:/api/index_management/indices`
--------------------------------------------------
When you paste the command into *Console*, {kib} automatically converts it
to *Console* syntax. Alternatively, if you want to see *Console* syntax in cURL,
click the action icon (image:dev-tools/console/images/wrench.png[]) and select *Copy as cURL*.

10
docs/user/api.asciidoc
View file

@ -9,11 +9,13 @@ deploying {kib}.
[[using-apis]]
== Using the APIs
Interact with the {kib} APIs through the `curl` command and HTTP and HTTPs protocols.
Prepend any {kib} API endpoint with `kbn:` and send the request through <<console-kibana, Dev Tools > Console>>.
For example:
It is recommended that you use HTTPs on port 5601 because it is more secure.
NOTE: The {kib} Console supports only Elasticsearch APIs. You are unable to interact with the {kib} APIs with the Console and must use `curl` or another HTTP tool instead. For more information, refer to <<console-kibana,Console>>.
[source,sh]
--------------------------------------------------
`GET kbn:/api/index_management/indices`
--------------------------------------------------
[float]
[[api-authentication]]

2
docs/user/dev-tools.asciidoc
View file

@ -12,7 +12,7 @@ with your data.
a| <<console-kibana, Console>>
| Interact with the REST API of Elasticsearch, including sending requests
| Interact with the REST APIs of {es} and {kib}, including sending requests
and viewing API documentation.
a| <<xpack-profiler, {searchprofiler}>>