Elasticsearch
Search, index, and manage data in Elasticsearch
Configuration
Search
Operation
Search
Deployment Type
Select...
Elasticsearch Host*
https://localhost:9200
Cloud ID*
deployment-name:base64-encoded-data
Authentication Method
Select...
API Key*
••••••••
Username*
Enter username
Password*
••••••••
Index Name*
my-index
Search Query
json
{ "match": { "field": "search term" } }
Number of Results
10
Offset
0
Sort
json
[{ "field": { "order": "asc" } }]
Fields to Include
field1, field2 (comma-separated)
Fields to Exclude
field1, field2 (comma-separated)
Search (
elasticsearch_search)Search documents in Elasticsearch using Query DSL. Returns matching documents with scores and metadata.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
deploymentType | string | Yes | Deployment type: self_hosted or cloud |
host | string | No | Elasticsearch host URL (for self-hosted) |
cloudId | string | No | Elastic Cloud ID (for cloud deployments) |
authMethod | string | Yes | Authentication method: api_key or basic_auth |
apiKey | string | No | Elasticsearch API key |
username | string | No | Username for basic auth |
password | string | No | Password for basic auth |
index | string | Yes | Index name to search |
query | string | No | Query DSL as JSON string |
from | number | No | Starting offset for pagination (default: 0) |
size | number | No | Number of results to return (default: 10) |
sort | string | No | Sort specification as JSON string |
sourceIncludes | string | No | Comma-separated list of fields to include in _source |
sourceExcludes | string | No | Comma-separated list of fields to exclude from _source |
trackTotalHits | boolean | No | Track accurate total hit count (default: true) |
Output
| Parameter | Type | Description |
|---|---|---|
took | number | Time in milliseconds the search took |
timed_out | boolean | Whether the search timed out |
hits | object | Search results with total count and matching documents |
Index Document
Operation
Index Document
Deployment Type
Select...
Elasticsearch Host*
https://localhost:9200
Cloud ID*
deployment-name:base64-encoded-data
Authentication Method
Select...
API Key*
••••••••
Username*
Enter username
Password*
••••••••
Index Name*
my-index
Document ID
Leave empty for auto-generated ID
Document*
json
{ "field": "value", "another_field": 123 }
Refresh
Select...
Index Document (
elasticsearch_index_document)Index (create or update) a document in Elasticsearch.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
deploymentType | string | Yes | Deployment type: self_hosted or cloud |
host | string | No | Elasticsearch host URL (for self-hosted) |
cloudId | string | No | Elastic Cloud ID (for cloud deployments) |
authMethod | string | Yes | Authentication method: api_key or basic_auth |
apiKey | string | No | Elasticsearch API key |
username | string | No | Username for basic auth |
password | string | No | Password for basic auth |
index | string | Yes | Target index name |
documentId | string | No | Document ID (auto-generated if not provided) |
document | string | Yes | Document body as JSON string |
refresh | string | No | Refresh policy: true, false, or wait_for |
Output
| Parameter | Type | Description |
|---|---|---|
_index | string | Index where the document was stored |
_id | string | Document ID |
_version | number | Document version |
Get Document
Operation
Get Document
Deployment Type
Select...
Elasticsearch Host*
https://localhost:9200
Cloud ID*
deployment-name:base64-encoded-data
Authentication Method
Select...
API Key*
••••••••
Username*
Enter username
Password*
••••••••
Index Name*
my-index
Document ID*
unique-document-id
Fields to Include
field1, field2 (comma-separated)
Fields to Exclude
field1, field2 (comma-separated)
Get Document (
elasticsearch_get_document)Retrieve a document by ID from Elasticsearch.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
deploymentType | string | Yes | Deployment type: self_hosted or cloud |
host | string | No | Elasticsearch host URL (for self-hosted) |
cloudId | string | No | Elastic Cloud ID (for cloud deployments) |
authMethod | string | Yes | Authentication method: api_key or basic_auth |
apiKey | string | No | Elasticsearch API key |
username | string | No | Username for basic auth |
password | string | No | Password for basic auth |
index | string | Yes | Index name |
documentId | string | Yes | Document ID to retrieve |
sourceIncludes | string | No | Comma-separated list of fields to include |
sourceExcludes | string | No | Comma-separated list of fields to exclude |
Output
| Parameter | Type | Description |
|---|---|---|
_index | string | Index name |
_id | string | Document ID |
_version | number | Document version |
found | boolean | Whether the document was found |
Update Document
Operation
Update Document
Deployment Type
Select...
Elasticsearch Host*
https://localhost:9200
Cloud ID*
deployment-name:base64-encoded-data
Authentication Method
Select...
API Key*
••••••••
Username*
Enter username
Password*
••••••••
Index Name*
my-index
Document ID*
unique-document-id
Partial Document*
json
{ "field_to_update": "new_value" }
Retry on Conflict
3
Update Document (
elasticsearch_update_document)Partially update a document in Elasticsearch using doc merge.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
deploymentType | string | Yes | Deployment type: self_hosted or cloud |
host | string | No | Elasticsearch host URL (for self-hosted) |
cloudId | string | No | Elastic Cloud ID (for cloud deployments) |
authMethod | string | Yes | Authentication method: api_key or basic_auth |
apiKey | string | No | Elasticsearch API key |
username | string | No | Username for basic auth |
password | string | No | Password for basic auth |
index | string | Yes | Index name |
documentId | string | Yes | Document ID to update |
document | string | Yes | Partial document to merge as JSON string |
retryOnConflict | number | No | Number of retries on version conflict |
Output
| Parameter | Type | Description |
|---|---|---|
_index | string | Index name |
_id | string | Document ID |
_version | number | New document version |
Delete Document
Operation
Delete Document
Deployment Type
Select...
Elasticsearch Host*
https://localhost:9200
Cloud ID*
deployment-name:base64-encoded-data
Authentication Method
Select...
API Key*
••••••••
Username*
Enter username
Password*
••••••••
Index Name*
my-index
Document ID*
unique-document-id
Refresh
Select...
Delete Document (
elasticsearch_delete_document)Delete a document from Elasticsearch by ID.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
deploymentType | string | Yes | Deployment type: self_hosted or cloud |
host | string | No | Elasticsearch host URL (for self-hosted) |
cloudId | string | No | Elastic Cloud ID (for cloud deployments) |
authMethod | string | Yes | Authentication method: api_key or basic_auth |
apiKey | string | No | Elasticsearch API key |
username | string | No | Username for basic auth |
password | string | No | Password for basic auth |
index | string | Yes | Index name |
documentId | string | Yes | Document ID to delete |
refresh | string | No | Refresh policy: true, false, or wait_for |
Output
| Parameter | Type | Description |
|---|---|---|
_index | string | Index name |
_id | string | Document ID |
_version | number | Document version |
Bulk Operations
Operation
Bulk Operations
Deployment Type
Select...
Elasticsearch Host*
https://localhost:9200
Cloud ID*
deployment-name:base64-encoded-data
Authentication Method
Select...
API Key*
••••••••
Username*
Enter username
Password*
••••••••
Index Name*
my-index
Bulk Operations*
json
{ "index": { "_index": "my-index", "_id": "1" } }\n{ "field": "value" }\n{ "delete": { "_index": "my-index", "_id": "2" } }
Refresh
Select...
Bulk Operations (
elasticsearch_bulk)Perform multiple index, create, delete, or update operations in a single request for high performance.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
deploymentType | string | Yes | Deployment type: self_hosted or cloud |
host | string | No | Elasticsearch host URL (for self-hosted) |
cloudId | string | No | Elastic Cloud ID (for cloud deployments) |
authMethod | string | Yes | Authentication method: api_key or basic_auth |
apiKey | string | No | Elasticsearch API key |
username | string | No | Username for basic auth |
password | string | No | Password for basic auth |
index | string | No | Default index for operations that do not specify one |
operations | string | Yes | Bulk operations as NDJSON string (newline-delimited JSON) |
refresh | string | No | Refresh policy: true, false, or wait_for |
Output
| Parameter | Type | Description |
|---|---|---|
took | number | Time in milliseconds the bulk operation took |
errors | boolean | Whether any operation had an error |
Count Documents
Operation
Count Documents
Deployment Type
Select...
Elasticsearch Host*
https://localhost:9200
Cloud ID*
deployment-name:base64-encoded-data
Authentication Method
Select...
API Key*
••••••••
Username*
Enter username
Password*
••••••••
Index Name*
my-index
Query
json
{ "match": { "field": "value" } }
Count Documents (
elasticsearch_count)Count documents matching a query in Elasticsearch.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
deploymentType | string | Yes | Deployment type: self_hosted or cloud |
host | string | No | Elasticsearch host URL (for self-hosted) |
cloudId | string | No | Elastic Cloud ID (for cloud deployments) |
authMethod | string | Yes | Authentication method: api_key or basic_auth |
apiKey | string | No | Elasticsearch API key |
username | string | No | Username for basic auth |
password | string | No | Password for basic auth |
index | string | Yes | Index name to count documents in |
query | string | No | Optional query to filter documents (JSON string) |
Output
| Parameter | Type | Description |
|---|---|---|
count | number | Number of documents matching the query |
Create Index
Operation
Create Index
Deployment Type
Select...
Elasticsearch Host*
https://localhost:9200
Cloud ID*
deployment-name:base64-encoded-data
Authentication Method
Select...
API Key*
••••••••
Username*
Enter username
Password*
••••••••
Index Name*
my-index
Index Settings
json
{ "number_of_shards": 1, "number_of_replicas": 1 }
Index Mappings
json
{ "properties": { "field": { "type": "text" } } }
Create Index (
elasticsearch_create_index)Create a new index with optional settings and mappings.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
deploymentType | string | Yes | Deployment type: self_hosted or cloud |
host | string | No | Elasticsearch host URL (for self-hosted) |
cloudId | string | No | Elastic Cloud ID (for cloud deployments) |
authMethod | string | Yes | Authentication method: api_key or basic_auth |
apiKey | string | No | Elasticsearch API key |
username | string | No | Username for basic auth |
password | string | No | Password for basic auth |
index | string | Yes | Index name to create |
settings | string | No | Index settings as JSON string |
mappings | string | No | Index mappings as JSON string |
Output
| Parameter | Type | Description |
|---|---|---|
acknowledged | boolean | Whether the request was acknowledged |
shards_acknowledged | boolean | Whether the shards were acknowledged |
Delete Index
Operation
Delete Index
Deployment Type
Select...
Elasticsearch Host*
https://localhost:9200
Cloud ID*
deployment-name:base64-encoded-data
Authentication Method
Select...
API Key*
••••••••
Username*
Enter username
Password*
••••••••
Index Name*
my-index
Delete Index (
elasticsearch_delete_index)Delete an index and all its documents. This operation is irreversible.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
deploymentType | string | Yes | Deployment type: self_hosted or cloud |
host | string | No | Elasticsearch host URL (for self-hosted) |
cloudId | string | No | Elastic Cloud ID (for cloud deployments) |
authMethod | string | Yes | Authentication method: api_key or basic_auth |
apiKey | string | No | Elasticsearch API key |
username | string | No | Username for basic auth |
password | string | No | Password for basic auth |
index | string | Yes | Index name to delete |
Output
Refer to the block outputs for this operation.
Get Index Info
Operation
Get Index Info
Deployment Type
Select...
Elasticsearch Host*
https://localhost:9200
Cloud ID*
deployment-name:base64-encoded-data
Authentication Method
Select...
API Key*
••••••••
Username*
Enter username
Password*
••••••••
Index Name*
my-index
Get Index Info (
elasticsearch_get_index)Retrieve index information including settings, mappings, and aliases.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
deploymentType | string | Yes | Deployment type: self_hosted or cloud |
host | string | No | Elasticsearch host URL (for self-hosted) |
cloudId | string | No | Elastic Cloud ID (for cloud deployments) |
authMethod | string | Yes | Authentication method: api_key or basic_auth |
apiKey | string | No | Elasticsearch API key |
username | string | No | Username for basic auth |
password | string | No | Password for basic auth |
index | string | Yes | Index name to retrieve info for |
Output
Refer to the block outputs for this operation.
Cluster Health
Operation
Cluster Health
Deployment Type
Select...
Elasticsearch Host*
https://localhost:9200
Cloud ID*
deployment-name:base64-encoded-data
Authentication Method
Select...
API Key*
••••••••
Username*
Enter username
Password*
••••••••
Wait for Status
Select...
Timeout (seconds)
30
Cluster Health (
elasticsearch_cluster_health)Get the health status of the Elasticsearch cluster.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
deploymentType | string | Yes | Deployment type: self_hosted or cloud |
host | string | No | Elasticsearch host URL (for self-hosted) |
cloudId | string | No | Elastic Cloud ID (for cloud deployments) |
authMethod | string | Yes | Authentication method: api_key or basic_auth |
apiKey | string | No | Elasticsearch API key |
username | string | No | Username for basic auth |
password | string | No | Password for basic auth |
waitForStatus | string | No | Wait until cluster reaches this status: green, yellow, or red |
timeout | string | No | Timeout for the wait operation (e.g., 30s, 1m) |
Output
| Parameter | Type | Description |
|---|---|---|
cluster_name | string | Name of the cluster |
status | string | Cluster health status: green, yellow, or red |
number_of_nodes | number | Total number of nodes in the cluster |
number_of_data_nodes | number | Number of data nodes |
active_shards | number | Number of active shards |
Cluster Stats
Operation
Cluster Stats
Deployment Type
Select...
Elasticsearch Host*
https://localhost:9200
Cloud ID*
deployment-name:base64-encoded-data
Authentication Method
Select...
API Key*
••••••••
Username*
Enter username
Password*
••••••••
Cluster Stats (
elasticsearch_cluster_stats)Get comprehensive statistics about the Elasticsearch cluster.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
deploymentType | string | Yes | Deployment type: self_hosted or cloud |
host | string | No | Elasticsearch host URL (for self-hosted) |
cloudId | string | No | Elastic Cloud ID (for cloud deployments) |
authMethod | string | Yes | Authentication method: api_key or basic_auth |
apiKey | string | No | Elasticsearch API key |
username | string | No | Username for basic auth |
password | string | No | Password for basic auth |
Output
| Parameter | Type | Description |
|---|---|---|
cluster_name | string | Name of the cluster |
status | string | Cluster health status |
nodes | object | Node statistics including count and versions |
Usage Instructions
Integrate Elasticsearch into workflows for powerful search, indexing, and data management. Supports document CRUD operations, advanced search queries, bulk operations, index management, and cluster monitoring. Works with both self-hosted and Elastic Cloud deployments.
Notes
- Category:
tools - Type:
elasticsearch