46 lines
2.2 KiB
Markdown
46 lines
2.2 KiB
Markdown
---
|
|
layout: default
|
|
title: REST API reference
|
|
nav_order: 1
|
|
has_toc: false
|
|
has_children: true
|
|
nav_exclude: true
|
|
redirect_from:
|
|
- /opensearch/rest-api/index/
|
|
---
|
|
|
|
# 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.
|
|
|
|
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.
|
|
{: .tip }
|
|
|
|
## Related articles
|
|
|
|
- [Alias]({{site.url}}{{site.baseurl}}/api-reference/alias/)
|
|
- [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/)
|
|
- [Common parameters]({{site.url}}{{site.baseurl}}/api-reference/common-parameters)
|
|
- [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/)
|
|
|
|
|
|
|