Elasticsearch Request

Elasticsearch Request

Certified

Call Elasticsearch endpoint

Performs an arbitrary HTTP request through the configured connection. Supports query parameters and optional JSON body; useful for endpoints not covered by dedicated tasks.

yaml
type: io.kestra.plugin.elasticsearch.Request

Inserting a document in an index using POST request

yaml
id: elasticsearch_request
namespace: company.team

tasks:
  - id: request_post
    type: io.kestra.plugin.elasticsearch.Request
    connection:
      hosts:
       - "http://localhost:9200"
    method: "POST"
    endpoint: "my_index/_doc/john"
    body:
      name: "john"

Searching for documents using GET request

yaml
id: elasticsearch_request
namespace: company.team

tasks:
  - id: request_get
    type: io.kestra.plugin.elasticsearch.Request
    connection:
      hosts:
       - "http://localhost:9200"
    method: "GET"
    endpoint: "my_index/_search"
    parameters:
      q: 'name:"John Doe"'

Deleting document using DELETE request

yaml
id: elasticsearch_request
namespace: company.team

tasks:
  - id: request_delete
    type: io.kestra.plugin.elasticsearch.Request
    connection:
      hosts:
       - "http://localhost:9200"
    method: "DELETE"
    endpoint: "my_index/_doc/<_id>"
Properties

Elasticsearch connection

Connection settings shared by tasks; hosts are required.

Definitions
hosts*Requiredarray
SubTypestring
Min items1

Elasticsearch hosts

List of HTTP(S) endpoints including scheme and port, e.g. https://elasticsearch.com: 9200; at least one is required.

basicAuth

Basic authentication

Optional HTTP basic auth credentials rendered at runtime.

passwordstring

Basic auth password

Password for HTTP basic authentication.

usernamestring

Basic auth username

Username for HTTP basic authentication.

headersarray
SubTypestring

Custom HTTP headers

Headers sent on every request in Name: Value format, e.g. Authorization: Token XYZ.

pathPrefixstring

Request path prefix

Base path prepended to every Elasticsearch endpoint, e.g. /my/path. Use only when the cluster is served behind a proxy that requires a prefix; leave empty otherwise.

strictDeprecationModebooleanstring

Fail on warning headers

When true, any response containing Elasticsearch warning headers is treated as an error.

targetServerVersionintegerstring
Default8

Target Elasticsearch server major version

Major version used for compatibility headers (Accept and Content-Type). Set to 8 for Elasticsearch 8 clusters or 9 for Elasticsearch 9 clusters.

trustAllSslbooleanstring

Trust all SSL certificates

Skips certificate validation for HTTPS connections; use only with self-signed certificates in non-production.

Endpoint path

Relative path without scheme/host/port/prefix, e.g. my_index/_search.

Request body

Map or JSON string rendered at runtime and sent as JSON.

DefaultGET
Possible Values
CONNECTCUSTOMDELETEGETHEADOPTIONSPATCHPOSTPUTTRACE

HTTP method

Defaults to GET.

Query parameters

Optional key/value query string pairs.

Reference (ref) of the pluginDefaults to apply to this task.

Custom shard routing

Optional routing key hashed to pick the shard instead of using the document id.

Response body

HTTP status code

More Plugins in this Category

Liquibase
Liquibase

Tasks that run Liquibase change management commands.

Data

2 tasks

PostgreSQL
PostgreSQL

Tasks that connect to PostgreSQL via JDBC to run queries and loads.

Data

6 tasks

25 blueprints