> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Elasticsearch

> Elasticsearch is a distributed, RESTful search and analytics engine capable of addressing a growing number of use cases. It provides real-time search and analytics for all types of data.

![Elasticsearch logo](https://mintcdn.com/composio-preview/r7CO9m4_UWMVFnU7/images/toolkits/elasticsearch.svg?fit=max\&auto=format\&n=r7CO9m4_UWMVFnU7\&q=85\&s=a70bed2773cca43c48d38cec070b026f)

* **Category:** databases
* **Auth:** API\_KEY, BASIC
* **Composio-managed OAuth available?** N/A
* **Tools:** 4
* **Triggers:** 0
* **Slug:** `ELASTICSEARCH`
* **Version:** 20261101\_00

## Tools

> [accordion] Get Index Schema
>
> **Slug:** `ELASTICSEARCH_GET_INDEX_SCHEMA`
>
> Get schema and mapping information for a specific Elasticsearch index, including field mappings, settings, aliases, and field statistics.
>
> #### Input Parameters
>
> **index\_name** `string` *required*
>
> The name of the index to get schema information for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Indices
>
> **Slug:** `ELASTICSEARCH_LIST_INDICES`
>
> Tool to list all available Elasticsearch indices. Use when you need to get a list of indices in your Elasticsearch cluster, optionally filtering by pattern, health status, or other criteria.
>
> #### Input Parameters
>
> **index** `string`
>
> A comma-separated string of index names or wildcard expressions to limit the returned information. For example, 'my-index-\*,another-index'. If not provided, information for all indices is returned.
>
> **health** `string ("green" | "yellow" | "red")`
>
> The health status to filter indices by (green, yellow, or red).
>
> **sort\_by** `string`
>
> A comma-separated string of column names to sort by. For example, 'index,health'.
>
> **expand\_wildcards** `string ("open" | "closed" | "hidden" | "none" | "all")`
>
> Type of index that wildcard patterns can match. Supports comma-separated values, e.g., 'open,hidden'. 'all' matches all indices by default.
>
> **include\_primary\_shards\_only** `boolean`
>
> If true, only shows information about primary shards.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Ping Cluster
>
> **Slug:** `ELASTICSEARCH_PING_CLUSTER`
>
> Ping the Elasticsearch cluster's root endpoint to check connectivity and accessibility.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Query Index
>
> **Slug:** `ELASTICSEARCH_QUERY_INDEX`
>
> Tool to query an Elasticsearch index with various filters, time ranges, and pagination support. Use when you need to search for documents in an index with complex filtering criteria.
>
> #### Input Parameters
>
> **from** `integer`
>
> Starting offset for pagination (default: 0)
>
> **size** `integer`
>
> Number of results to return (default: 10, max: 1000 to prevent context overload)
>
> **sort** `array`
>
> Sort order for results
>
> **query** `string`
>
> Free text search query (uses query\_string query)
>
> **fields** `array`
>
> Specific fields to return (if not specified, returns all fields)
>
> **highlight** `boolean`
>
> Enable highlighting for search terms
>
> **index\_name** `string` *required*
>
> The name of the index to query. Must be a non-empty string.
>
> **time\_filter** `object`
>
> Time-based filter for timestamp fields
>
> **term\_filters** `array`
>
> Exact term filters for specific field values
>
> **range\_filters** `array`
>
> Range filters for numeric or date fields
>
> **include\_aggregations** `boolean`
>
> Include aggregations in the response
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
