2021-05-28 13:48:19 -04:00
---
layout: default
title: REST API reference
2022-10-27 12:50:39 -04:00
nav_order: 1
2023-05-19 14:33:20 -04:00
has_toc: false
has_children: true
2023-05-11 13:56:08 -04:00
nav_exclude: true
2021-06-10 18:09:17 -04:00
redirect_from:
2023-05-04 13:44:02 -04:00
- /opensearch/rest-api/index/
2021-05-28 13:48:19 -04:00
---
# REST API reference
2023-05-19 14:33:20 -04:00
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.
2021-06-10 15:48:49 -04:00
2023-05-19 14:33:20 -04:00
Most REST APIs supported by OpenSearch are included in this reference. If you know of any that are missing, feel free to enter feedback or submit a pull request.
2021-06-10 15:48:49 -04:00
{: .tip }
2023-05-19 14:33:20 -04:00
## Related articles
- [Analyze API ]({{site.url}}{{site.baseurl}}/api-reference/analyze-apis/index/ )
- [CAT APIs ]({{site.url}}{{site.baseurl}}/api-reference/cat/index/ )
- [Cluster APIs ]({{site.url}}{{site.baseurl}}/api-reference/cluster-api/index/ )
2023-05-25 16:31:30 -04:00
- [Common parameters ]({{site.url}}{{site.baseurl}}/api-reference/common-parameters/ )
2023-05-19 14:33:20 -04:00
- [Count ]({{site.url}}{{site.baseurl}}/api-reference/count/ )
- [Document ]({{site.url}}{{site.baseurl}}/api-reference/document-apis/index/ )
- [Explain ]({{site.url}}{{site.baseurl}}/api-reference/explain/ )
- [Index APIs ]({{site.url}}{{site.baseurl}}/api-reference/index-apis/index/ )
- [Ingest APIs ]({{site.url}}{{site.baseurl}}/api-reference/ingest-apis/index/ )
- [Multi-search ]({{site.url}}{{site.baseurl}}/api-reference/multi-search/ )
- [Nodes APIs ]({{site.url}}{{site.baseurl}}/api-reference/nodes-apis/index/ )
- [Popular APIs ]({{site.url}}{{site.baseurl}}/api-reference/popular-api/ )
- [Ranking evaluation ]({{site.url}}{{site.baseurl}}/api-reference/rank-eval/ )
- [Reload search analyzer ]({{site.url}}{{site.baseurl}}/api-reference/reload-search-analyzer/ )
- [Remove cluster information ]({{site.url}}{{site.baseurl}}/api-reference/remote-info/ )
- [Script APIs ]({{site.url}}{{site.baseurl}}/api-reference/script-apis/index/ )
- [Scroll ]({{site.url}}{{site.baseurl}}/api-reference/scroll/ )
- [Search ]({{site.url}}{{site.baseurl}}/api-reference/search/ )
- [Snapshot APIs ]({{site.url}}{{site.baseurl}}/api-reference/snapshots/index/ )
- [Supported units ]({{site.url}}{{site.baseurl}}/api-reference/units/ )
- [Tasks ]({{site.url}}{{site.baseurl}}/api-reference/tasks/ )