Tools

Elasticsearch

Learn how to use Elasticsearch with Composio

Overview

Enum

ELASTICSEARCH

Description

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.

Authentication Details

api_key
stringRequired
base_url
stringRequired
username
stringRequired
password
stringRequired
base_url
stringRequired

Actions

Tool to get the complete schema/mapping of a specific elasticsearch index. use when you need to understand the structure, field types, and mappings of an index.

Action Parameters

index_name
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

expand_wildcards
string
health
string
include_primary_shards_only
boolean
index
string
sort_by
string

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

fields
array
from
integer
highlight
boolean
include_aggregations
boolean
index_name
stringRequired
query
string
range_filters
array
size
integerDefaults to 10
sort
array
term_filters
array
time_filter
object

Action Response

data
object
error
string
successful
boolean