index.md

layout	title	nav_order	has_toc	has_children	nav_exclude	permalink	redirect_from
default	REST API reference	1	false	true	true	/api-reference/	/opensearch/rest-api/index/ /api-reference/index/

API reference

You can use REST APIs for most operations in OpenSearch. Starting with OpenSearch 3.0, you can use alternative experimental gRPC APIs.

REST APIs

Introduced 1.0 {: .label .label-purple }

OpenSearch supports the following REST APIs:

• 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
• Vector search API
• ML Commons API
• Multi-search
• Nodes APIs
• Notifications API
• Performance analyzer API
• Point in Time API
• Popular APIs
• Ranking evaluation
• Refresh search analyzer
• Remote 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
• Hot reload TLS certificates

gRPC APIs

Introduced 3.0 {: .label .label-purple }

Starting with OpenSearch 3.0, you can use gRPC APIs---a high-performance alternative to traditional REST interfaces. These APIs use the gRPC protocol to provide more efficient communication with OpenSearch clusters. For more information and supported APIs, see gRPC APIs.