Elasticsearch

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.

Tools

`elasticsearch_search`

Search documents in Elasticsearch using Query DSL. Returns matching documents with scores and metadata.

Input

Parameter	Type	Required	Description
`deploymentType`	string	Yes	No description
`host`	string	No	No description
`cloudId`	string	No	No description
`authMethod`	string	Yes	No description
`apiKey`	string	No	No description
`username`	string	No	No description
`password`	string	No	No description
`index`	string	Yes	Index name to search (e.g., "products", "logs-2024")
`query`	string	No	Query DSL as JSON string. Example: {"match":{"title":"search term"}} or {"bool":{"must":[...]}}
`from`	number	No	No description
`size`	number	No	No description
`sort`	string	No	Sort specification as JSON string. Example: [{"created_at":"desc"}] or [{"_score":"desc"},{"name":"asc"}]
`sourceIncludes`	string	No	No description
`sourceExcludes`	string	No	No description
`trackTotalHits`	boolean	No	No description

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
`aggregations`	json	Aggregation results if any

`elasticsearch_index_document`

Input

Parameter	Type	Required	Description
`deploymentType`	string	Yes	No description
`host`	string	No	No description
`cloudId`	string	No	No description
`authMethod`	string	Yes	No description
`apiKey`	string	No	No description
`username`	string	No	No description
`password`	string	No	No description
`index`	string	Yes	Target index name (e.g., "products", "logs-2024")
`documentId`	string	No	Document ID (e.g., "abc123", "user_456"). Auto-generated if not provided
`document`	string	Yes	No description
`refresh`	string	No	No description

Output

Parameter	Type	Description
`_index`	string	Index where the document was stored
`_id`	string	Document ID
`_version`	number	Document version
`result`	string	Operation result (created or updated)

`elasticsearch_get_document`

Input

Parameter	Type	Required	Description
`deploymentType`	string	Yes	No description
`host`	string	No	No description
`cloudId`	string	No	No description
`authMethod`	string	Yes	No description
`apiKey`	string	No	No description
`username`	string	No	No description
`password`	string	No	No description
`index`	string	Yes	Index name (e.g., "products", "logs-2024")
`documentId`	string	Yes	Document ID to retrieve (e.g., "abc123", "user_456")
`sourceIncludes`	string	No	No description
`sourceExcludes`	string	No	No description

Output

Parameter	Type	Description
`_index`	string	Index name
`_id`	string	Document ID
`_version`	number	Document version
`found`	boolean	Whether the document was found
`_source`	json	Document content

`elasticsearch_update_document`

Input

Parameter	Type	Required	Description
`deploymentType`	string	Yes	No description
`host`	string	No	No description
`cloudId`	string	No	No description
`authMethod`	string	Yes	No description
`apiKey`	string	No	No description
`username`	string	No	No description
`password`	string	No	No description
`index`	string	Yes	Index name (e.g., "products", "logs-2024")
`documentId`	string	Yes	Document ID to update (e.g., "abc123", "user_456")
`document`	string	Yes	No description
`retryOnConflict`	number	No	No description

Output

Parameter	Type	Description
`_index`	string	Index name
`_id`	string	Document ID
`_version`	number	New document version
`result`	string	Operation result (updated or noop)

`elasticsearch_delete_document`

Input

Parameter	Type	Required	Description
`deploymentType`	string	Yes	No description
`host`	string	No	No description
`cloudId`	string	No	No description
`authMethod`	string	Yes	No description
`apiKey`	string	No	No description
`username`	string	No	No description
`password`	string	No	No description
`index`	string	Yes	Index name (e.g., "products", "logs-2024")
`documentId`	string	Yes	Document ID to delete (e.g., "abc123", "user_456")
`refresh`	string	No	No description

Output

Parameter	Type	Description
`_index`	string	Index name
`_id`	string	Document ID
`_version`	number	Document version
`result`	string	Operation result (deleted or not_found)

`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	No description
`host`	string	No	No description
`cloudId`	string	No	No description
`authMethod`	string	Yes	No description
`apiKey`	string	No	No description
`username`	string	No	No description
`password`	string	No	No description
`index`	string	No	Default index for operations (e.g., "products", "logs-2024")
`operations`	string	Yes	Bulk operations as NDJSON string. Each operation is two lines: action metadata and optional document. Example: {"index":{"_index":"products","_id":"1"}}\n{"name":"Widget"}\n
`refresh`	string	No	No description

Output

Parameter	Type	Description
`took`	number	Time in milliseconds the bulk operation took
`errors`	boolean	Whether any operation had an error
`items`	array	Results for each operation

`elasticsearch_count`

Input

Parameter	Type	Required	Description
`deploymentType`	string	Yes	No description
`host`	string	No	No description
`cloudId`	string	No	No description
`authMethod`	string	Yes	No description
`apiKey`	string	No	No description
`username`	string	No	No description
`password`	string	No	No description
`index`	string	Yes	Index name to count documents in (e.g., "products", "logs-2024")
`query`	string	No	Query DSL to filter documents (JSON string). Example: {"match":{"status":"active"}}

Output

Parameter	Type	Description
`count`	number	Number of documents matching the query
`_shards`	object	Shard statistics

`elasticsearch_create_index`

Input

Parameter	Type	Required	Description
`deploymentType`	string	Yes	No description
`host`	string	No	No description
`cloudId`	string	No	No description
`authMethod`	string	Yes	No description
`apiKey`	string	No	No description
`username`	string	No	No description
`password`	string	No	No description
`index`	string	Yes	Index name to create (e.g., "products", "logs-2024")
`settings`	string	No	No description
`mappings`	string	No	No description

Output

Parameter	Type	Description
`acknowledged`	boolean	Whether the request was acknowledged
`shards_acknowledged`	boolean	Whether the shards were acknowledged
`index`	string	Created index name

`elasticsearch_delete_index`

Input

Parameter	Type	Required	Description
`deploymentType`	string	Yes	No description
`host`	string	No	No description
`cloudId`	string	No	No description
`authMethod`	string	Yes	No description
`apiKey`	string	No	No description
`username`	string	No	No description
`password`	string	No	No description
`index`	string	Yes	Index name to delete (e.g., "products", "logs-2024")

Output

Parameter	Type	Description
`acknowledged`	boolean	Whether the deletion was acknowledged

`elasticsearch_get_index`

Input

Parameter	Type	Required	Description
`deploymentType`	string	Yes	No description
`host`	string	No	No description
`cloudId`	string	No	No description
`authMethod`	string	Yes	No description
`apiKey`	string	No	No description
`username`	string	No	No description
`password`	string	No	No description
`index`	string	Yes	Index name to retrieve info for (e.g., "products", "logs-2024")

Output

Parameter	Type	Description
`index`	json	Index information including aliases, mappings, and settings

`elasticsearch_cluster_health`

Input

Parameter	Type	Required	Description
`deploymentType`	string	Yes	No description
`host`	string	No	No description
`cloudId`	string	No	No description
`authMethod`	string	Yes	No description
`apiKey`	string	No	No description
`username`	string	No	No description
`password`	string	No	No description
`waitForStatus`	string	No	No description
`timeout`	string	No	No description

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
`unassigned_shards`	number	Number of unassigned shards

`elasticsearch_cluster_stats`

Input

Parameter	Type	Required	Description
`deploymentType`	string	Yes	No description
`host`	string	No	No description
`cloudId`	string	No	No description
`authMethod`	string	Yes	No description
`apiKey`	string	No	No description
`username`	string	No	No description
`password`	string	No	No description

Output

Parameter	Type	Description
`cluster_name`	string	Name of the cluster
`status`	string	Cluster health status
`nodes`	object	Node statistics including count and versions
`indices`	object	Index statistics including document count and store size

`elasticsearch_list_indices`

List all indices in the Elasticsearch cluster with their health, status, and statistics.

Input

Parameter	Type	Required	Description
`deploymentType`	string	Yes	No description
`host`	string	No	No description
`cloudId`	string	No	No description
`authMethod`	string	Yes	No description
`apiKey`	string	No	No description
`username`	string	No	No description
`password`	string	No	No description

Output

Parameter	Type	Description
`message`	string	Summary message about the indices
`indices`	json	Array of index information objects

Elasticsearch

On this page