Skip to content

Update getting-started.asciidoc #8434

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.

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
Dec 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 8 additions & 9 deletions docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,22 +26,21 @@ Refer to the <<installation>> page to learn more.
[discrete]
=== Connecting

You can connect to the Elastic Cloud using an API key and the Elasticsearch
endpoint.
You can connect to the Elastic Cloud using an API key and your Elasticsearch
Cloud ID.

[source,net]
----
var client = new ElasticsearchClient("<CLOUD_ID>", new ApiKey("<API_KEY>"));
----

Your Elasticsearch endpoint can be found on the **My deployment** page of your
deployment:
You can find your Elasticsearch Cloud ID on the deployment page:

image::images/es-endpoint.jpg[alt="Finding Elasticsearch endpoint",align="center"]
image::images/es-cloudid.jpg[alt="Cloud ID on the deployment page",align="center"]

You can generate an API key on the **Management** page under Security.

image::images/create-api-key.png[alt="Create API key",align="center"]
To generate an API key, use the
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html[Elasticsearch Create API key API]
or https://www.elastic.co/guide/en/kibana/current/api-keys.html#create-api-key[Kibana Stack Management].

For other connection options, refer to the <<connecting>> section.

Expand Down Expand Up @@ -158,4 +157,4 @@ var response = await client.Indices.DeleteAsync("my_index");
== Further reading

* Refer to the <<recommendations>> page to learn more about how to use the
client the most efficiently.
client the most efficiently.
Binary file added docs/images/es-cloudid.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading