elasticsearch/docs/reference/tab-widgets/api-call.asciidoc
Liam Thompson fd775317ed
[DOCS] Create Elasticsearch basics section, refactor quickstarts section (#112436) (#113543)
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
2024-09-26 01:55:19 +10:00

57 lines
No EOL
1.2 KiB
Text

// tag::cloud[]
**Option 1: Use {kib}**
//tag::kibana-api-ex[]
. Open {kib}'s main menu ("*☰*" near Elastic logo) and go to **Dev Tools > Console**.
+
[role="screenshot"]
image::images/kibana-console.png[{kib} Console,align="center"]
. Run the following test API request in Console:
+
[source,console]
----
GET /
----
//end::kibana-api-ex[]
**Option 2: Use `curl`**
To communicate with {es} using `curl` or another client, you need your cluster's
endpoint.
. Open {kib}'s main menu and click **Manage this deployment**.
. From your deployment menu, go to the **Elasticsearch** page. Click **Copy
endpoint**.
. To submit an example API request, run the following `curl` command in a new
terminal session. Replace `<password>` with the password for the `elastic` user.
Replace `<elasticsearch_endpoint>` with your endpoint.
+
[source,sh]
----
curl -u elastic:<password> <elasticsearch_endpoint>/
----
// NOTCONSOLE
// end::cloud[]
// tag::self-managed[]
**Use {kib}**
include::api-call.asciidoc[tag=kibana-api-ex]
**Use curl**
To submit an example API request, run the following curl command in a new
terminal session.
[source,sh]
----
curl -u elastic:$ELASTIC_PASSWORD https://localhost:9200
----
// NOTCONSOLE
// end::self-managed[]