REST API reference

OpenSearch uses its REST API for most operations. This incomplete section includes REST API paths, HTTP verbs, supported parameters, request body details, and sample responses.

In general, the OpenSearch REST API is no different from the Elasticsearch OSS REST API; most client code that worked with Elasticsearch OSS should also work with OpenSearch.

Table of contents

• Index APIs
• Ingest APIs
• Nodes APIs
• Search
• Alias
• Document APIs
• Cluster allocation explain
• Cluster health
• Cluster settings
• Cluster stats
• Remote cluster information
• Tasks
• CAT API
• Scroll
• Multi-search
• Explain
• Count