RequestRequest
RequestCertified

Send a request to an OpenSearch cluster.

Send a request to an OpenSearch cluster.

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

The connection properties.

Definitions
hosts*Requiredarray
SubTypestring

List of HTTP OpenSearch servers.

Must be an URI like https://opensearch.com: 9200 with scheme and port.

basicAuth

Basic auth configuration.

passwordstring

Basic auth password.

usernamestring

Basic auth username.

headersarray
SubTypestring

List of HTTP headers to be send on every request.

Must be a string with key value separated with : , ex: Authorization: Token XYZ.

pathPrefixstring

Sets the path's prefix for every request used by the HTTP client.

For example, if this is set to /my/path, then any client request will become /my/path/ + endpoint. In essence, every request's endpoint is prefixed by this pathPrefix. The path prefix is useful for when OpenSearch is behind a proxy that provides a base path or a proxy that requires all paths to start with '/'; it is not intended for other purposes and it should not be supplied in other scenarios.

strictDeprecationModebooleanstring

Whether the REST client should return any response containing at least one warning header as a failure.

trustAllSslbooleanstring

Trust all SSL CA certificates.

Use this if the server is using a self signed SSL certificate.

The path of the request (without scheme, host, port, or prefix).

The full body.

Can be a JSON string or raw Map that will be converted to json.

DefaultGET
Possible Values
CONNECTCUSTOMDELETEGETHEADOPTIONSPATCHPOSTPUTTRACE

The http method to use.

SubTypestring

Query string parameters.

Controls the shard routing of the request.

Using this value to hash the shard and not the id.