
Security News
ECMAScript 2025 Finalized with Iterator Helpers, Set Methods, RegExp.escape, and More
ECMAScript 2025 introduces Iterator Helpers, Set methods, JSON modules, and more in its latest spec update approved by Ecma in June 2025.
@elastic/search-ui-elasticsearch-connector
Advanced tools
A Search UI connector for Elasticsearch
Part of the Search UI project.
This Connector is used to connect Search UI directly to Elasticsearch.
npm install --save @elastic/search-ui-elasticsearch-connector
import ElasticsearchAPIConnector from "@elastic/search-ui-elasticsearch-connector";
const connector = new ElasticsearchAPIConnector({
cloud: {
id: "<elastic-cloud-id>"
},
index: "search-ui-examples", // index name where the search documents are contained
apiKey: "apiKeyExample" // Optional. apiKey used to authorize a connection to Elasticsearch instance.
// This key will be visible to everyone so ensure its setup with restricted privileges.
// See Authentication section for more details.
});
Kind: global class
Param | Type |
---|---|
options | Options |
Kind: global typedef
Param | Type | Default | Description |
---|---|---|---|
cloud | Object | { id: string } | Elastic cloud configuration. Can be found in your cloud deployment dashboard. |
host | string | Elasticsearch host. | |
index | string | Index name for where the search documents are contained in | |
apiKey | string | Optional. Credential thats setup within Kibana's UI. see kibana API keys guide. |
search_fields
object is required with all fields you want to search by.This connector will talk to the elasticsearch instance directly from the browser. This requires further additional steps to keep your Elasticsearch instance secure as possible. You have the following options available to you to keep any sensitive data protected
This envolves building an API route that will proxy the elasticsearch call through your API. During the proxy, you are able to:
To do this, provide the host to be the location of the API. Example host: "https://search.acme.co/search", index: "movies"
. In this example, you would need to implement a POST endpoint for https://search.acme.co/search/movies/_search
. When the connector performs a network request, the Elasticsearch Query DSL will be contained within the body.
You can restrict access to indices via an api-key. See kibana API keys guide
FAQs
A Search UI connector for Elasticsearch
The npm package @elastic/search-ui-elasticsearch-connector receives a total of 6,323 weekly downloads. As such, @elastic/search-ui-elasticsearch-connector popularity was classified as popular.
We found that @elastic/search-ui-elasticsearch-connector demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 67 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ECMAScript 2025 introduces Iterator Helpers, Set methods, JSON modules, and more in its latest spec update approved by Ecma in June 2025.
Security News
A new Node.js homepage button linking to paid support for EOL versions has sparked a heated discussion among contributors and the wider community.
Research
North Korean threat actors linked to the Contagious Interview campaign return with 35 new malicious npm packages using a stealthy multi-stage malware loader.