OpenSearch icon

OpenSearch

Consume the OpenSearch API

Actions10

Index → Get

AI-generated

Summary

Retrieve information about a specified OpenSearch index, optionally controlling wildcard matching, missing-index handling, settings format, default settings, locality, and master-node timeout. The node makes a GET request and returns the selected index’s information with its ID added as id.

Inputs

  • Index ID (required) — The index name or target to retrieve; OpenSearch wildcard and alias behavior can be affected by Additional Fields.
  • Additional Fields — Optional OpenSearch request parameters: Allow No Indices, Expand Wildcards, Flat Settings, Ignore Unavailable, Include Defaults, Local, and Master Timeout. These control missing or closed targets, wildcard expansion, settings in the response, which node supplies the information, and how long to wait for the master node.

Output shape

A single index-information object per input item.

The response contains the selected index’s OpenSearch information with an id field set to the supplied Index ID. Missing or unavailable targets can produce an error depending on the selected options and OpenSearch behavior.

Links

Discussion