Skip to main content

Elasticsearch

Introduction​

The Elasticsearch connector lets you sync data from an Elasticsearch-compatible cluster (including OpenSearch) into your workspace.

Setup​

  1. Get your cluster endpoint

    • Use the base URL for your cluster, for example:
      • https://my-cluster.example.com/
      • https://my-cluster.example.com:9200/

  2. Create an API key

    • Create an API key in Elasticsearch/OpenSearch with permission to access the indices you want to sync.
    • Keep the API key value available for configuration.

Authentication​

This connector authenticates using an API key sent in the Authorization header:

  • Header format: Authorization: ApiKey <api_key>

During credential validation, the connector calls:

  • GET <endpoint>/_cluster/health

Configuration​

FieldTypeRequiredDescription
endpointstring✅Base URL of your Elasticsearch/OpenSearch cluster. Must be a valid URL.
api_keystring✅API key used to authenticate to the cluster.

Streams​

Streams depend on your Elasticsearch/OpenSearch indices and mappings.

If you need specific streams documented for your deployment, provide the index patterns and any relevant mappings you want to sync.