Skip to content

Elasticsearch

Elasticsearch connector allows querying Elasticsearch clusters using their native REST API.

Config Schema

FieldTypeRequiredDescription
typestringyesconstant: elasticsearch
hostsstring[]yesList of Elasticsearch nodes (e.g., [“http://localhost:9200”])
userstringnoUsername for authentication
passwordstringnoPassword for authentication
api_keystringnoAPI key for authentication (alternative to username/password)
cloud_idstringnoCloud ID for Elastic Cloud deployments
indexstringnoDefault index to query
tls_verifybooleannoVerify TLS certificates (default: true)
conn_stringstringnoDirect connection string

Config example:

connection:
type: elasticsearch
hosts:
- http://localhost:9200
- http://es-node2:9200
user: elastic
password: secret
index: my_index
tls_verify: true

Or as alternative with direct connection string:

connection:
type: elasticsearch
conn_string: https://elastic:secret@localhost:9200

Authentication Methods

The connector supports multiple authentication methods:

  1. Basic Authentication (username/password)
  2. API Key Authentication
  3. No Authentication (for development)

For Elastic Cloud deployments, you can use the cloud_id parameter instead of hosts:

connection:
type: elasticsearch
cloud_id: deployment:dXMtZWFzdC0xLmF3cy5mb3VuZC5pbyQ0ZmE...
api_key: your_api_key

Notes

  • The connector uses the official Elasticsearch Go client
  • For high availability, specify multiple hosts - the client will automatically handle failover
  • TLS is required for production deployments
  • When using API keys, both username and password should be omitted
  • The index parameter is optional but recommended to set a default index for queries
  • Supports Elasticsearch version 7.x and above