Skip to main content

Connect to Elasticsearch

Learn how to connect your Elasticsearch database to Retool.

You can use the Elasticsearch integration to create a resource and make it available in Retool. Once complete, your users can write queries that interact with Elasticsearch data.

Requirements​

The Elasticsearch integration requirements depend on whether you have a cloud-hosted or self-hosted Retool organization. You may also need to make Elasticsearch configuration changes before creating the resource.

Sufficient user permissions to create resources

All users for Retool organizations on Free or Team plans have global Edit permissions and can add, edit, and remove resources. If your organization manages user permissions for resources, you must be a member of a group with Edit all permissions.

Allow Retool to access the data source

If the data source is behind a firewall or restricts access based on IP address, then you must ensure that your Retool organization can access it. If necessary, configure your data source to allow access from Retool's IP addresses.

CIDR IP addresses
3.77.79.248/30
35.90.103.132/30
44.208.168.68/30
Individual IP addresses
3.77.79.249
3.77.79.250
35.90.103.132
35.90.103.133
35.90.103.134
35.90.103.135
44.208.168.68
44.208.168.69
44.208.168.70
44.208.168.71

Retool is building support for querying firewalled resources without allowlisting Retool’s IP address. To learn more or be considered for early access, contact cloud-connect@retool.com.

Elasticsearch settings and authentication

You must have sufficient access and familiarity with your Elasticsearch data source so you can provide:

  • Required connection settings (e.g., URL and server variables).
  • Authentication credentials (e.g., API keys).

In some cases, you may need to make changes to your Elasticsearch configuration, such as generating authentication credentials or allowing access through a firewall. Refer to the configuration and authentication sections to learn more.

Configure the resource​

Sign in to your Retool organization and navigate to the Resources tab. Click Create new > Resource, then select Elasticsearch.

Configuration​

Specify the name, location, and description to use for your Elasticsearch resource. Retool displays the resource name and type in query editors to help users identify them.

Provide the following configuration settings to create the resource. Depending on how your data source is configured, you may also need to provide optional settings for Retool to connect.

Name

The name to use for the resource.

Description

A description of the resource.

Base URL

The base URL for all requests (e.g., https://example.com).

Enable SSH tunnel

Whether to enable SSH tunneling.

Bastion host

The Bastion host.

Bastion port

The Bastion port.

Override default outbound Retool region

Retool connects to your data source from the us-west-2 region. Choosing a different outbound region can improve performance through geographic proximity.

RegionLocation
us-west-2US West (Oregon)
eu-central-1(Frankfurt, Germany)

Authentication​

The Elasticsearch integration supports the following authentication methods. Depending on which authentication method you use, you may need to make changes to your Elasticsearch configuration.

API key

Authentication is performed using the API key. You must be able to obtain and provide these credentials to create the resource.

Basic

Authentication is performed using Basic HTTP authentication with a username and password. You must be able to obtain and provide these credentials to create the resource.

SSL/TLS validation​

Retool strongly recommends enabling SSL/TLS certificate validation whenever it's available. This ensures the connection is secure and prevents attackers from using invalid server certificates to gain access to your data.

Some resources support or require SSL/TLS validation. If needed, provide the following information to configure SSL.

CA Cert

The CA certificate to use.

Client key

The client key.

Client cert

The client certificate.

Verification mode

The mode with which Retool performs SSL/TLS verification.

ModeDescription
Full verificationVerifies the server host matches the name stored in the server certificate and checks the CA certificate.
Verify CA certificateThis verifies the server by checking the certificate chain up to the root certificate stored on the client.
Skip CA certificate verification CautionThis establishes an encrypted connection without CA certificate verification. This mode is not recommended as your server could be vulnerable.

Test the connection​

Click Test Connection to verify that Retool can successfully connect to the data source. If the test fails, check the resource settings and try again.

Testing a connection only checks whether Retool can successfully connect to the resource. It cannot check whether the provided credentials have sufficient privileges or can perform every supported action.

Save the resource​

Click Create resource to complete the setup. You can then click either Create app to immediately start building a Retool app or Back to resources to return to the list of resources.

Next steps​

Your Elasticsearch resource is now ready to use. Check out related queries and code documentation to learn how to interact with Elasticsearch data.