API Gateway 11.1 | Administering API Gateway | Operating API Gateway | Destination Configuration | Configuring external Elasticsearch Destination
 
Configuring external Elasticsearch Destination
 
Troubleshooting Tips: Elasticsearch Destination
You have to configure the external Elasticsearch as a destination to establish a communication channel between API Gateway and the external Elasticsearch to exchange data.
*To configure the external Elasticsearch destination
1. Expand the menu options icon menu_options, in the title bar, and select Administration.
2. Select Destinations.
3. Select Elasticsearch > Configuration to configure the external Elasticsearch as the destination.
4. Provide the following information in the Basic information section:
Field
Description
Protocol
Specifies the communication protocol used to establish communication between API Gateway and the external Elasticsearch.
Hostname
Specifies the host name or IP address of the machine on which the external Elasticsearch is running.
Port
Specifies the port where the external Elasticsearch server runs. The default port number is 9240.
Index alias
Specifies the index alias for the external Elasticsearch, where certain data is stored. This data stored helps in simplifying operations like searches, filtering, and routing across multiple indices
The index alias links two or more indices. By linking multiple indices, you can designate one index as the primary write index while others serve as read-only replicas.
This configuration allows you to define a destination alias. The size or age of the write index grows based on the configured ILM policy. The external Elasticsearch automatically creates a new write index while marking the previous one as read-only. Through this approach, you can effectively manage index size and age.
Username
Specifies the external Elasticsearch user ID for authenticating the external Elasticsearch when API Gateway communicates with it.
Password
Specifies the password of the external Elasticsearch instance to be used for establishing communication between API Gateway and the external Elasticsearch.
Note:
You can provide the username and password for the external Elasticsearch instances having configured with Basic authentication. You can also provide HTTPS enabled the external Elasticsearch instance.
5. Click Test.
This tests the communication channel between API Gateway and the configured the external Elasticsearch.
6. Click Save to save the specified email configuration value.
You can click Cancel to revert to the last saved changes or to abandon all the changes if the values are not saved.