Skip to content

[DOCS] Adds curl explanation to getting started content #51963

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 6, 2020
Merged

[DOCS] Adds curl explanation to getting started content #51963

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4e4625d
[DOCS] Adds curl intro
lcawl Feb 5, 2020
e351af0
[DOCS] Fixes codes snippet tests
lcawl Feb 5, 2020
6a763ad
[DOCS] Fixes formatting of list
lcawl Feb 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 40 additions & 3 deletions docs/reference/getting-started.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,9 +156,7 @@ The cat APIs return information about your cluster and indices in a
format that's easier to read than raw JSON.
+
You can interact directly with your cluster by submitting HTTP requests to
the {es} REST API. Most of the examples in this guide enable you to copy the
appropriate cURL command and submit the request to your local {es} instance from
the command line. If you have Kibana installed and running, you can also
the {es} REST API. If you have Kibana installed and running, you can also
open Kibana and submit requests through the Dev Console.
+
TIP: You'll want to check out the
Expand Down Expand Up @@ -189,6 +187,45 @@ cannot be replicated to another node to provide resiliency. Replica shards must
be available for the cluster status to be green. If the cluster status is red,
some data is unavailable.

[discrete]
[[gs-curl]]
=== Talking to {es} with cURL commands

Most of the examples in this guide enable you to copy the appropriate cURL
command and submit the request to your local {es} instance from the command line.

A request to Elasticsearch consists of the same parts as any HTTP request:

[source,sh]
--------------------------------------------------
curl -X<VERB> '<PROTOCOL>://<HOST>:<PORT>/<PATH>?<QUERY_STRING>' -d '<BODY>'
--------------------------------------------------
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this needs // NOTCONSOLE to pass the CI checks.

// NOTCONSOLE

This example uses the following variables:

`<VERB>`:: The appropriate HTTP method or verb. For example, `GET`, `POST`,
`PUT`, `HEAD`, or `DELETE`.
`<PROTOCOL>`:: Either `http` or `https`. Use the latter if you have an HTTPS
proxy in front of {es} or you use {es} {security-features} to encrypt HTTP
communications.
`<HOST>`:: The hostname of any node in your {es} cluster. Alternatively, use
+localhost+ for a node on your local machine.
`<PORT>`:: The port running the {es} HTTP service, which defaults to `9200`.
`<PATH>`:: The API endpoint, which can contain multiple components, such as
`_cluster/stats` or `_nodes/stats/jvm`.
`<QUERY_STRING>`:: Any optional query-string parameters. For example, `?pretty`
will _pretty-print_ the JSON response to make it easier to read.
`<BODY>`:: A JSON-encoded request body (if necessary).

If the {es} {security-features} are enabled, you must also provide a valid user
name (and password) that has authority to run the API. For example, use the
`-u` or `--u` cURL command parameter. For details about which security
privileges are required to run each API, see <<rest-apis>>.

{es} responds to each API request with an HTTP status code like `200 OK`. With
the exception of `HEAD` requests, it also returns a JSON-encoded response body.

[float]
[[gs-other-install]]
=== Other installation options
Expand Down