OpenSearch Get

OpenSearch Get
Certified
Retrieve a document from OpenSearch

Fetches one document by index and id with optional routing and version match; returns the source map.

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

Examples

yaml
id: opensearch_get
namespace: company.team

tasks:
  - id: get
    type: io.kestra.plugin.opensearch.Get
    connection:
      hosts:
        - "http://localhost:9200"
    index: "my_index"
    key: "my_id"
    docVersion: 1

Properties

connection *

Configure OpenSearch connection

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

Definitions

io.kestra.plugin.opensearch.OpensearchConnection

hosts*array

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

io.kestra.plugin.opensearch.OpensearchConnection-BasicAuth

passwordstring

Basic auth password

usernamestring

Basic auth username

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.

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

INSECURE — disables TLS certificate and hostname verification entirely, allowing 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.