Skip to content

Docs: update Elasticsearch credentials documentation #3851

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Docs: update Elasticsearch credentials documentation #3851

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
12edbc8
Update Elasticsearch credentials documentation
justincastilla Nov 3, 2025
bac8a94
Remove unnecessary word in Elasticsearch credentials documentation
justincastilla Nov 3, 2025
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
39 changes: 30 additions & 9 deletions docs/integrations/builtin/credentials/elasticsearch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,29 +14,50 @@ You can use these credentials to authenticate the following nodes:
## Supported authentication methods

- Basic auth
- API-Key and Endpoint Authentication

You will need a **Base URL** (also known as the Elasticsearch endpoint) for either method. To find the endpoint:

1. In Elasticsearch, go to **Deployments**.
2. Select your deployment.
3. Select **Manage this deployment**.
4. In the **Applications** section, copy the endpoint of the **Elasticsearch** application.

## Related resources

Refer to [Elasticsearch's documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html) for more information about the service.

## Using an API-Key and Endpoint (recommended)

To configure this credential, you'll need an [Elasticsearch](https://www.elastic.co/) account with a [deployment](https://www.elastic.co/docs/deploy-manage/deploy/elastic-cloud/create-an-organization) and:

- An [API Key](https://www.elastic.co/docs/deploy-manage/api-keys/elasticsearch-api-keys)
- Your Elasticsearch application's **Base URL**

To set up the credential:

1. Enter your Elasticsearch **Base URL**
2. Choose **API Key** as the Authentication type
3. Enter your Elasticsearch **API Key**
4. By default, n8n connects only if SSL certificate validation succeeds. If you'd like to connect even if SSL certificate validation fails, turn on **Ignore SSL Issues**.

## Using basic auth

To configure this credential, you'll need an [Elasticsearch](https://www.elastic.co/) account with a [deployment](https://www.elastic.co/guide/en/cloud/current/ec-create-deployment.html) and:

- A **Username**
- A **Password**
- Your Elasticsearch application's **Base URL** (also known as the Elasticsearch application endpoint)
- Your Elasticsearch application's **Base URL**

The basic auth method will **not** work with Elastic Serverless

To set up the credential:

1. Enter your Elasticsearch **Username**.
2. Enter your Elasticsearch **Password**.
3. In Elasticsearch, go to **Deployments**.
4. Select your deployment.
5. Select **Manage this deployment**.
6. In the **Applications** section, copy the endpoint of the **Elasticsearch** application.
7. Enter this in n8n as the **Base URL**.
8. By default, n8n connects only if SSL certificate validation succeeds. If you'd like to connect even if SSL certificate validation fails, turn on **Ignore SSL Issues**.
1. Enter your Elasticsearch **Base URL**
2. Choose **Basic Auth** as the Authentication type
3. Enter your Elasticsearch **Username**.
4. Enter your Elasticsearch **Password**.
5. By default, n8n connects only if SSL certificate validation succeeds. If you'd like to connect even if SSL certificate validation fails, turn on **Ignore SSL Issues**.

/// note | Custom endpoint aliases
If you add a [custom endpoint alias](https://www.elastic.co/guide/en/cloud/current/ec-regional-deployment-aliases.html) to a deployment, update your n8n credential **Base URL** with the new endpoint.
Expand Down