On this page
The Elastic Cloud Endpoint connector type
Choose the Elastic Cloud Endpoint connector type if you'd like to connect to an Elastic Cloud instance with an Elasticsearch endpoint (it looks like a URL).
Start from Search API's configuration at /admin/config/search/search-api, and click the + Add server button at the top of the page. Or go to /admin/config/search/search-api/add-server
For more information, see the Search API documentation on Adding a server.
Name and Machine name
Start by entering a Server name. A Machine name for the server will be generated automatically (but you can edit it by clicking the [Edit] link).
Enabled toggle
The Enabled checkbox allows you to quickly enable/disable the Server. Search API checks to see if a Server is enabled before doing anything with it.
Description
The optional Description text area allows you to enter a description for the Server. This is useful when you have set up more than one Server, and/or you need to migrate to a new Elasticsearch cluster in the future.
Backend chooser
The Backend radio-button lets you choose which Search API Backend to use to connect to the Search API Server.
Because you are reading the Elasticsearch Connector guide, you should set Backend to ElasticSearch.
The rest of this guide will assume that you have set Backend to ElasticSearch.
Configure ElasticSearch backend
The Configure ElasticSearch backend details element tells Search API how to connect to an Elasticsearch server.
ElasticSearch Connector
The ElasticSearch Connector radio-button lets you choose which method to use when connecting to the Elasticsearch cluster.
Because you are reading the Elastic Cloud Endpoint connector type page, you should set ElasticSearch Connector to Elastic Cloud Endpoint.
The other pages in this section of the guide document how to use the other ElasticSearch Connector options.
Configure Elastic Cloud Endpoint ElasticSearch Connector
The Configure Elastic Cloud Endpoint ElasticSearch Connector details element tells Search API where to connect to the Elasticsearch cluster.
Elasticsearch endpoint
Enter the Elasticsearch Endpoint of the Elastic Cloud Serverless or Elastic Cloud Hosted cluster you set up earlier. An Elastic Cloud Endpoint looks a URL.
Elastic Cloud API key
In the Elastic Cloud API key select list, choose the Key that you configured to store the API Key that you obtained from Elasticsearch.
If you don't see a select list here, and instead you see a message saying...
You must install Drupal's Key module to use this authentication type! Please ensure that the Key module is downloaded and enabled.
... then you will need to install and enable Drupal's Key module.
Enable debugging mode: log ElasticSearch network traffic
The Enable debugging mode: log ElasticSearch network traffic checkbox might help you diagnose problems with Drupal's connection to Elasticsearch by writing requests, responses, and response-time information to Drupal's log.
Warning: Checking Enable debugging mode: log ElasticSearch network traffic will result in poor performance and may log a user’s personally identifiable information!
This setting is only intended for temporary use and should be disabled when you finish debugging.
Logs written while this mode is active will remain in the log until you clear them or the logs are rotated.
Advanced
See the Advanced server settings documentation.
Next steps
Click the Save button, then proceed to Adding a Search API Index.
Help improve this page
You can:
- Log in, click Edit, and edit this page
- Log in, click Discuss, update the Page status value, and suggest an improvement
- Log in and create a Documentation issue with your suggestion
