-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of github.com:elastic/docs-content into serverles…
…s_intro_update
- Loading branch information
Showing
25 changed files
with
289 additions
and
1,606 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
[[elasticsearch-connecting-to-es-serverless-endpoint]] | ||
= Connecting to your Elasticsearch Serverless endpoint | ||
|
||
[TIP] | ||
==== | ||
This page assumes you have already <<elasticsearch-get-started-create-project,created an {es-serverless} project>>. | ||
==== | ||
|
||
Learn how to securely connect to your Elasticsearch Serverless instance. | ||
|
||
To connect to your Elasticsearch instance from your applications, client libraries, or tools like `curl`, you'll need two key pieces of information: an API key and your endpoint URL. This guide shows you how to get these connection details and verify they work. | ||
|
||
[discrete] | ||
[[elasticsearch-get-started-create-api-key]] | ||
== Create a new API key | ||
|
||
Create an API key to authenticate your requests to the {es} APIs. You'll need an API key for all API requests and client connections. | ||
|
||
To create a new API key: | ||
|
||
. On the **Getting Started** page, scroll to **Add an API Key** and select **New**. You can also search for *API keys* in the https://www.elastic.co/guide/en/kibana/current/kibana-concepts-analysts.html#_finding_your_apps_and_objects[global search field]. | ||
+ | ||
image::images/create-an-api-key.png[Create an API key.] | ||
. In **Create API Key**, enter a name for your key and (optionally) set an expiration date. | ||
. (Optional) Under **Control Security privileges**, you can set specific access permissions for this API key. By default, it has full access to all APIs. | ||
. (Optional) The **Add metadata** section allows you to add custom key-value pairs to help identify and organize your API keys. | ||
. Select **Create API Key** to finish. | ||
|
||
After creation, you'll see your API key displayed as an encoded string. | ||
Store this encoded API key securely. It is displayed only once and cannot be retrieved later. | ||
You will use this encoded API key when sending API requests. | ||
|
||
[NOTE] | ||
==== | ||
You can't recover or retrieve a lost API key. Instead, you must delete the key and create a new one. | ||
==== | ||
|
||
[discrete] | ||
[[elasticsearch-get-started-endpoint]] | ||
== Get your {es} endpoint URL | ||
|
||
The endpoint URL is the address for your {es} instance. | ||
You'll use this URL together with your API key to make requests to the {es} APIs. | ||
To find the endpoint URL: | ||
|
||
|
||
. On the **Getting Started** page, scroll to **Copy your connection details** section, and find the **Elasticsearch endpoint** field. | ||
. Copy the URL for the Elasticsearch endpoint. | ||
|
||
image::images/copy-connection-details.png[Copy your Elasticsearch endpoint.] | ||
|
||
[discrete] | ||
[[elasticsearch-get-started-test-connection]] | ||
== Test connection | ||
|
||
Use https://curl.se[`curl`] to verify your connection to {es}. | ||
|
||
`curl` will need access to your Elasticsearch endpoint and `encoded` API key. | ||
Within your terminal, assign these values to the `ES_URL` and `API_KEY` environment variables. | ||
|
||
For example: | ||
|
||
[source,bash] | ||
---- | ||
export ES_URL="https://dda7de7f1d264286a8fc9741c7741690.es.us-east-1.aws.elastic.cloud:443" | ||
export API_KEY="ZFZRbF9Jb0JDMEoxaVhoR2pSa3Q6dExwdmJSaldRTHFXWEp4TFFlR19Hdw==" | ||
---- | ||
|
||
Then run the following command to test your connection: | ||
|
||
[source,bash] | ||
---- | ||
curl "${ES_URL}" \ | ||
-H "Authorization: ApiKey ${API_KEY}" \ | ||
-H "Content-Type: application/json" | ||
---- | ||
|
||
You should receive a response similar to the following: | ||
|
||
[source,json] | ||
---- | ||
{ | ||
"name" : "serverless", | ||
"cluster_name" : "dda7de7f1d264286a8fc9741c7741690", | ||
"cluster_uuid" : "ws0IbTBUQfigmYAVMztkZQ", | ||
"version" : { ... }, | ||
"tagline" : "You Know, for Search" | ||
} | ||
---- | ||
|
||
Now you're ready to start adding data to your {es-serverless} project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.