Elasticsearch

Visão geral

Elasticsearch é um mecanismo de busca e análise distribuído, baseado em REST, capaz de lidar com uma variedade crescente de casos de uso. Ele fornece busca e análise em tempo real para todos os tipos de dados. Com a integração no SquadOS, seus agentes podem consultar índices, listar estruturas de dados e verificar a saúde de clusters Elasticsearch diretamente em fluxos de automação.

• Documentação na Composio: docs.composio.dev/toolkits/elasticsearch

Autenticação

Esta ferramenta utiliza chave de API (API_KEY) ou autenticação básica (usuário/senha) (BASIC) para conectar.

Você vai precisar dos seguintes campos:

Campo	Obrigatório	Descrição
api_key	Sim (para API_KEY)	Chave de API gerada no painel do Elasticsearch para autenticar requisições.
username	Sim (para BASIC)	Nome de usuário da conta Elasticsearch.
password	Sim (para BASIC)	Senha da conta Elasticsearch.

Como obter a credencial

Usando chave de API (recomendado):

1. Acesse o painel do seu cluster Elasticsearch (Kibana ou Elastic Cloud Console).
2. Navegue até Stack Management → Security → API Keys.
3. Clique em Create API key.
4. Defina um nome para a chave e configure as permissões necessárias (acesso de leitura/escrita nos índices desejados).
5. Clique em Create e copie a chave gerada — ela é exibida apenas uma vez.

Usando autenticação básica:

1. Use o nome de usuário e senha de um usuário Elasticsearch com as permissões adequadas.
2. Para clusters Elastic Cloud, localize as credenciais em Security → Users.

Dica

Prefira chaves de API em vez de usuário/senha em produção. Chaves podem ser revogadas individualmente sem afetar outras integrações e permitem controle fino de permissões por índice.

Como conectar no SquadOS

1. Acesse Ferramentas no menu lateral (/admin/tools).
2. Abra a aba Disponíveis e procure por Elasticsearch.
3. Clique no card para abrir o modal de detalhes e em Conectar.
4. Você é levado para a página de conexão segura hospedada pela Composio, onde informa as credenciais obtidas acima.
5. Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)

Ações disponíveis

Obter esquema do índice

ELASTICSEARCH_GET_INDEX_SCHEMA

Obtém o esquema/mapeamento completo de um índice Elasticsearch específico. Use quando precisar entender a estrutura, os tipos de campos e os mapeamentos de um índice.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
index_name	string	Sim	O nome do índice para o qual obter informações de esquema.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar índices

ELASTICSEARCH_LIST_INDICES

Lista todos os índices Elasticsearch disponíveis. Use quando precisar obter uma lista de índices no seu cluster Elasticsearch, opcionalmente filtrando por padrão, status de saúde ou outros critérios.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
index	string	Não	String separada por vírgulas com nomes de índices ou expressões curinga para limitar as informações retornadas. Por exemplo, my-index-*,another-index. Se não fornecido, retorna informações de todos os índices.
health	string	Não	Status de saúde para filtrar os índices (green, yellow ou red).
sort_by	string	Não	String separada por vírgulas com nomes de colunas para ordenação. Por exemplo, index,health.
expand_wildcards	string	Não	Tipo de índice que padrões curinga podem corresponder. Suporta valores separados por vírgula, ex.: open,hidden. all corresponde a todos os índices por padrão. Opções: open, closed, hidden, none, all.
include_primary_shards_only	boolean	Não	Se verdadeiro, exibe apenas informações sobre shards primários.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Verificar cluster

ELASTICSEARCH_PING_CLUSTER

Faz um ping no cluster Elasticsearch e verifica se ele está em execução. Use quando precisar confirmar a conectividade e o status de saúde do cluster antes de realizar operações.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Consultar índice

ELASTICSEARCH_QUERY_INDEX

Consulta um índice Elasticsearch com suporte a filtros variados, intervalos de tempo e paginação. Use quando precisar buscar documentos em um índice com critérios de filtragem complexos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
from	integer	Não	Deslocamento inicial para paginação (padrão: 0).
size	integer	Não	Número de resultados a retornar (padrão: 10, máximo: 1000 para evitar sobrecarga de contexto).
sort	array	Não	Ordem de classificação dos resultados.
query	string	Não	Consulta de texto livre (usa query_string).
fields	array	Não	Campos específicos a retornar (se não especificado, retorna todos os campos).
highlight	boolean	Não	Habilitar realce dos termos de busca.
index_name	string	Sim	O nome do índice a consultar. Deve ser uma string não vazia.
time_filter	object	Não	Filtro baseado em tempo para campos de timestamp.
term_filters	array	Não	Filtros de termo exato para valores de campos específicos.
range_filters	array	Não	Filtros de intervalo para campos numéricos ou de data.
include_aggregations	boolean	Não	Incluir agregações na resposta.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.