Elasticsearch Indices

The Elasticsearch Indices component, allows you to talk with Elasticsearch. Requires Elasticsearch 8.4.x or higher.

Configuration

Action

Choose from one of the following:

• Put Template
• Refresh

Connection

Connection URL

Connection URL to the API endpoint

Example: https://localhost:9200/

Authentication

Username As required by the API

Example: elastic

Password As required by the API

Example: changeMe

HTTP(s)

The path to the Elasticsearch certificate

Example: Home/Documents/Elasticsearch/config/certs/http_ca.crt

Rate limit

Request limit

The max amount of requests during the interval.

Interval

The interval in milliseconds in which the requests happen. Should be a multiple of 250.

Max concurrent

The maximum concurrent executions.

Inputs

• Name: Input

  • Description:

    As an input, this component takes any message and sends it to the method corresponding to the selected action in the drop-down menu.

    On error, the default error handling applies.

  • Action: Put Template

    • Description:

      Use the put template API to create or update an index template or component template. An index template is a way to tell Elasticsearch how to configure an index when it is created. For data streams, the index template configures the stream’s backing indices as they are created. Templates are configured prior to index creation. When an index is created, either manually or through indexing a document, the template settings are used as a basis for creating the index. An index template can be composed of multiple component templates. To use a component template, specify it in an index template’s composed_of list. Component templates are only applied to new data streams and indices as part of a matching index template.

    • Example:

      {
        name: "helloWorld", 
        body: { 
          index_patterns: ["hello*", "world*"], 
          version: 1 
        } 
      }

  • Action: Refresh

    • Description: Use the refresh API to explicitly make all operations performed on one or more indices since the last refresh available for search. If the request targets a data stream, it refreshes the stream’s backing indices. If no index is specified it will refresh all data streams and indices in a cluster.

    • Example:

      {
          index: ""
      }

Outputs

• Name: Output

  • Description: On successful execution, the output will be the response of Elasticsearch.

  • Example:

    {
      value: // incoming data
      result: // Elastic response
    }

  • Example: Put Template:

    {
      "value": {
        "name": "helloWorld",
        "body": {
          "index_patterns": [
            "hello*",
            "world*"
          ],
          "version": 1
        }
      },
      "result": {
        "acknowledged": true
      }
    }

  • Example: Refresh:

    {
      "value": {
        "index": ""
      },
      "result": {
        "_shards": {
        "total": 0,
        "successful": 0,
        "failed": 0
        }
      }
    }