OpenSearch Request

OpenSearch Request

Certified

Send raw OpenSearch HTTP request

Issue ad-hoc HTTP calls against the cluster with dynamic endpoint, parameters, and optional JSON body; defaults to GET.

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

Inserting a document in an index using POST request.

yaml
id: opensearch_request
namespace: company.team

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

Searching for documents using GET request.

yaml
id: opensearch_request
namespace: company.team

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

Deleting document using DELETE request.

yaml
id: opensearch_request
namespace: company.team

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

Configure OpenSearch connection

Hosts, auth headers, and TLS options reused by every task invocation.

Definitions
hosts*Requiredarray
SubTypestring

OpenSearch HTTP endpoints

One or more host URLs with scheme and port, e.g. https://opensearch.com: 9200; all are used for load-balancing/failover.

basicAuth

Basic auth configuration

passwordstring

Basic auth password

usernamestring

Basic auth username

connectTimeoutstring

Connection timeout

Maximum time to wait when establishing the TCP connection to an OpenSearch node before giving up. RestClient's own default is 1 second when this is left unset.

headersarray
SubTypestring

Additional HTTP headers

Each entry is Key: Value, e.g. Authorization: Token XYZ; rendered per request.

pathPrefixstring

Path prefix for every request

Prepends /my/path to all endpoints when OpenSearch is behind a proxy enforcing a base path; leave unset otherwise.

responseTimeoutstring

Response timeout

Maximum time to wait for a response once a request has been sent to an OpenSearch node before giving up. RestClient's own default is 30 seconds when this is left unset.

strictDeprecationModebooleanstring

Fail on warning headers

If true, any response containing an OpenSearch warning header is treated as a failure; defaults to server/client behavior.

trustAllSslbooleanstring

Trust all SSL certificates

WARNING — SECURITY RISK: When enabled, disables TLS certificate chain validation, allowing connections to servers with self-signed or otherwise untrusted certificates. Hostname verification remains enforced to reduce (but not eliminate) exposure to man-in-the-middle attacks. Must never be used against production clusters or over untrusted networks. Prefer supplying a trusted CA certificate/trust store instead.

Request path

Endpoint without scheme/host/port; pathPrefix from the connection is prepended automatically.

Request body

Accepts a JSON string or Map rendered then serialized as JSON.

DefaultGET
Possible Values
CONNECTCUSTOMDELETEGETHEADOPTIONSPATCHPOSTPUTTRACE

HTTP method

Defaults to GET when not set.

Query string parameters

Shard routing key

Hashes routing using this value instead of the document id to colocate related records.

Response body returned by OpenSearch

HTTP status code returned by OpenSearch

More Plugins in this Category

Prefect
Prefect

Tasks that trigger Prefect deployments and monitor flow runs.

Data

1 tasks

1 blueprints

Azure (EE)
Azure
Enterprise

Tasks that integrate Microsoft Azure services into Kestra enterprise workflows.

CloudDataInfrastructure

7 tasks