67 lines
3.8 KiB
Markdown
67 lines
3.8 KiB
Markdown
---
|
|
layout: default
|
|
title: REST API reference
|
|
nav_order: 1
|
|
has_toc: false
|
|
has_children: true
|
|
nav_exclude: true
|
|
permalink: /api-reference/
|
|
redirect_from:
|
|
- /opensearch/rest-api/index/
|
|
- /api-reference/index/
|
|
---
|
|
|
|
# REST API reference
|
|
**Introduced 1.0**
|
|
{: .label .label-purple }
|
|
|
|
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.
|
|
{: .tip }
|
|
|
|
## Related articles
|
|
|
|
- [Analyze API]({{site.url}}{{site.baseurl}}/api-reference/analyze-apis/)
|
|
- [Access control API]({{site.url}}{{site.baseurl}}/security/access-control/api/)
|
|
- [Alerting API]({{site.url}}{{site.baseurl}}/observing-your-data/alerting/api/)
|
|
- [Anomaly detection API]({{site.url}}{{site.baseurl}}/observing-your-data/ad/api/)
|
|
- [CAT APIs]({{site.url}}{{site.baseurl}}/api-reference/cat/index/)
|
|
- [Cluster APIs]({{site.url}}{{site.baseurl}}/api-reference/cluster-api/index/)
|
|
- [Common REST parameters]({{site.url}}{{site.baseurl}}/api-reference/common-parameters/)
|
|
- [Count]({{site.url}}{{site.baseurl}}/api-reference/count/)
|
|
- [Cross-cluster replication API]({{site.url}}{{site.baseurl}}/tuning-your-cluster/replication-plugin/api/)
|
|
- [Document APIs]({{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/)
|
|
- [Index rollups API]({{site.url}}{{site.baseurl}}/im-plugin/index-rollups/rollup-api/)
|
|
- [Index state management API]({{site.url}}{{site.baseurl}}/im-plugin/ism/api/)
|
|
- [ISM error prevention API]({{site.url}}{{site.baseurl}}/im-plugin/ism/error-prevention/api/)
|
|
- [Ingest APIs]({{site.url}}{{site.baseurl}}/api-reference/ingest-apis/index/)
|
|
- [k-NN plugin API]({{site.url}}{{site.baseurl}}/search-plugins/knn/api/)
|
|
- [ML Commons API]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/)
|
|
- [Multi-search]({{site.url}}{{site.baseurl}}/api-reference/multi-search/)
|
|
- [Nodes APIs]({{site.url}}{{site.baseurl}}/api-reference/nodes-apis/index/)
|
|
- [Notifications API]({{site.url}}{{site.baseurl}}/observing-your-data/notifications/api/)
|
|
- [Performance analyzer API]({{site.url}}{{site.baseurl}}/monitoring-your-cluster/pa/api/)
|
|
- [Point in Time API]({{site.url}}{{site.baseurl}}/search-plugins/point-in-time-api/)
|
|
- [Popular APIs]({{site.url}}{{site.baseurl}}/api-reference/popular-api/)
|
|
- [Ranking evaluation]({{site.url}}{{site.baseurl}}/api-reference/rank-eval/)
|
|
- [Refresh search analyzer]({{site.url}}{{site.baseurl}}/im-plugin/refresh-analyzer/)
|
|
- [Remove cluster information]({{site.url}}{{site.baseurl}}/api-reference/remote-info/)
|
|
- [Root cause analysis API]({{site.url}}{{site.baseurl}}/monitoring-your-cluster/pa/rca/api/)
|
|
- [Snapshot management API]({{site.url}}{{site.baseurl}}/tuning-your-cluster/availability-and-recovery/snapshots/sm-api/)
|
|
- [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/)
|
|
- [Search relevance stats API]({{site.url}}{{site.baseurl}}/search-plugins/search-relevance/stats-api/)
|
|
- [Security analytics APIs]({{site.url}}{{site.baseurl}}/security-analytics/api-tools/index/)
|
|
- [Snapshot APIs]({{site.url}}{{site.baseurl}}/api-reference/snapshots/index/)
|
|
- [Stats API]({{site.url}}{{site.baseurl}}/tuning-your-cluster/availability-and-recovery/stats-api/)
|
|
- [Supported units]({{site.url}}{{site.baseurl}}/api-reference/units/)
|
|
- [Tasks]({{site.url}}{{site.baseurl}}/api-reference/tasks/)
|
|
- [Transforms API]({{site.url}}{{site.baseurl}}/im-plugin/index-transforms/transforms-apis/)
|
|
|
|
|
|
|