REST API reference

You can use REST APIs for most operations in OpenSearch. In this reference, we provide a description of the API, and details that include the paths and HTTP methods, supported parameters, and example requests and responses.

This reference includes the REST APIs supported by OpenSearch. If a REST API is missing, please provide feedback or submit a pull request in GitHub.

Related articles

• Analyze API
• Access control API
• Alerting API
• Anomaly detection API
• CAT APIs
• Cluster APIs
• Common REST parameters
• Count
• Cross-cluster replication API
• Document APIs
• Explain
• Index APIs
• Index rollups API
• Index state management API
• ISM error prevention API
• Ingest APIs
• k-NN plugin API
• ML Commons API
• Multi-search
• Nodes APIs
• Notifications API
• Performance analyzer API
• Point in Time API
• Popular APIs
• Ranking evaluation
• Refresh search analyzer
• Remove cluster information
• Root cause analysis API
• Snapshot management API
• Script APIs
• Scroll
• Search
• Search relevance stats API
• Security analytics APIs
• Snapshot APIs
• Stats API
• Supported units
• Tasks
• Transforms API