Skip to content

Commit 52f1c05

Browse files
committed
Provide API descriptions.
1 parent 927796f commit 52f1c05

File tree

1 file changed

+175
-44
lines changed
  • docs/reference/elasticsearch/rest-apis

1 file changed

+175
-44
lines changed

docs/reference/elasticsearch/rest-apis/index.md

Lines changed: 175 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -19,47 +19,178 @@ This section includes:
1919

2020
## API endpoints
2121

22-
* [Autoscaling](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-autoscaling)
23-
* [Behavioral analytics](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-analytics)
24-
* [Compact and aligned text (CAT)](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-cat)
25-
* [Cluster](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-cluster)
26-
* [Cluster - Health](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-health_report)
27-
* [Connector](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-connector)
28-
* [Cross-cluster replication (CCR)](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-ccr)
29-
* [Data stream](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-data-stream)
30-
* [Document](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-document)
31-
* [Enrich](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-enrich)
32-
* [EQL](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-eql)
33-
* [ES|QL](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-esql)
34-
* [Features](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-features)
35-
* [Fleet](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-fleet)
36-
* [Graph explore](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-graph)
37-
* [Index](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-indices)
38-
* [Index lifecycle management](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-ilm)
39-
* [Inference](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-inference)
40-
* [Info](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-info)
41-
* [Ingest](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-ingest)
42-
* [Licensing](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-license)
43-
* [Logstash](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-logstash)
44-
* [Machine learning](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-ml)
45-
* [Machine learning anomaly detection](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-ml-anomaly)
46-
* [Machine learning data frame analytics](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-ml-data-frame)
47-
* [Machine learning trained models](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-ml-trained-model)
48-
* [Migration](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-migration)
49-
* [Node lifecycle](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-shutdown)
50-
* [Query rules](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-query_rules)
51-
* [Rollup](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-rollup)
52-
* [Script](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-script)
53-
* [Search](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-search)
54-
* [Search application](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-search_application)
55-
* [Searchable snapshots](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-searchable_snapshots)
56-
* [Security](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-security)
57-
* [Snapshot and restore](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-snapshot)
58-
* [Snapshot lifecycle management](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-slm)
59-
* [SQL](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-sql)
60-
* [Synonyms](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-synonyms)
61-
* [Task management](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-tasks)
62-
* [Text structure](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-text_structure)
63-
* [Transform](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-transform)
64-
* [Usage](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-xpack)
65-
* [Watcher](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-watcher)
22+
### [Autoscaling](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-autoscaling)
23+
24+
The autoscaling APIs enable you to create and manage autoscaling policies and retrieve information about autoscaling capacity. Autoscaling adjusts resources based on demand. A deployment can use autoscaling to scale resources as needed, ensuring sufficient capacity to meet workload requirements.
25+
26+
### [Behavioral analytics](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-analytics)
27+
28+
The behavioral analytics APIs enable you to create and manage analytics collections and retrieve information about analytics collections. Behavioral Analytics is an analytics event collection platform. You can use it to analyze your users' searching and clicking behavior. Leverage this information to improve the relevance of your search results and identify gaps in your content.
29+
30+
### [Compact and aligned text (CAT)](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-cat)
31+
32+
The compact and aligned text (CAT) APIs return human-readable text as a response, instead of a JSON object. The CAT APIs aim are intended only for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, it's recommend to use a corresponding JSON API.
33+
34+
### [Cluster](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-cluster)
35+
36+
The cluster APIs enable you to retrieve information about your infrastructure on cluster, node, or shard level. You can manage cluster settings and voting configuration exceptions, collect node statistics and retrieve node information.
37+
38+
### [Cluster - Health](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-health_report)
39+
40+
The cluster - health API provides you a report with the health status of an Elasticsearch cluster.
41+
42+
### [Connector](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-connector)
43+
44+
The connector and sync jobs APIs provide a convenient way to create and manage Elastic connectors and sync jobs in an internal index.
45+
46+
### [Cross-cluster replication (CCR)](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-ccr)
47+
48+
The cross-cluster replication (CCR) APIs enable you to run cross-cluster replication operations, such as creating and managing follower indices or auto-follow patterns. With CCR, you can replicate indices across clusters to continue handling search requests in the event of a datacenter outage, prevent search volume from impacting indexing throughput, and reduce search latency by processing search requests in geo-proximity to the user.
49+
50+
### [Data stream](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-data-stream)
51+
52+
The data stream APIs enable you to create and manage data streams and data stream lifecycles. A data stream lets you store append-only time series data across multiple indices while giving you a single named resource for requests. Data streams are well-suited for logs, events, metrics, and other continuously generated data.
53+
54+
### [Document](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-document)
55+
56+
The document APIs enable you to create and manage documents in an {{es}} index.
57+
58+
### [Enrich](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-enrich)
59+
60+
The enrich APIs enable you to manage enrich policies. An enrich policy is a set of configuration options used to add the right enrich data to the right incoming documents.
61+
62+
### [EQL](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-eql)
63+
64+
The EQL APIs enable you to run EQL-related operations. Event Query Language (EQL) is a query language for event-based time series data, such as logs, metrics, and traces.
65+
66+
### [ES|QL](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-esql)
67+
68+
The ES|QL APIs enable you to run ES|QL-related operations. The Elasticsearch Query Language (ES|QL) provides a powerful way to filter, transform, and analyze data stored in Elasticsearch, and in the future in other runtimes.
69+
70+
### [Features](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-features)
71+
72+
The feature APIs enable you to introspect and manage features provided by {{es}} and {{es}} plugins.
73+
74+
### [Fleet](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-fleet)
75+
76+
The Fleet APIs support Fleet’s use of Elasticsearch as a data store for internal agent and action data.
77+
78+
### [Graph explore](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-graph)
79+
80+
The graph explore APIs enable you to extract and summarize information about the documents and terms in an {{es}} data stream or index.
81+
82+
### [Index](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-indices)
83+
84+
The index APIs enable you to manage individual indices, index settings, aliases, mappings, and index templates.
85+
86+
### [Index lifecycle management](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-ilm)
87+
88+
The index lifecycle management APIs enable you to set up policies to automatically manage the index lifecycle.
89+
90+
### [Inference](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-inference)
91+
92+
The inference APIs enable you to create inference endpoints and integrate with machine learning models of different services - such as Amazon Bedrock, Anthropic, Azure AI Studio, Cohere, Google AI, Mistral, OpenAI, or HuggingFace.
93+
94+
### [Info](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-info)
95+
96+
The info API provides basic build, version, and cluster information.
97+
98+
### [Ingest](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-ingest)
99+
100+
The ingest APIs enable you to manage tasks and resources related to ingest pipelines and processors.
101+
102+
### [Licensing](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-license)
103+
104+
The licensing APIs enable you to manage your licenses.
105+
106+
### [Logstash](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-logstash)
107+
108+
The logstash APIs enable you to manage pipelines that are used by Logstash Central Management.
109+
110+
### [Machine learning](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-ml)
111+
112+
The machine learning APIs enable you to retrieve information related to the {{stack}} {{ml}} features.
113+
114+
### [Machine learning anomaly detection](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-ml-anomaly)
115+
116+
The machine learning anomaly detection APIs enbale you to perform anomaly detection activities.
117+
118+
### [Machine learning data frame analytics](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-ml-data-frame)
119+
120+
The machine learning data frame analytics APIs enbale you to perform data frame analytics activities.
121+
122+
### [Machine learning trained models](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-ml-trained-model)
123+
124+
The machine learning trained models APIs enable you to perform model management operations.
125+
126+
### [Migration](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-migration)
127+
128+
The migration APIs power {{kib}}'s Upgrade Assistant feature.
129+
130+
### [Node lifecycle](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-shutdown)
131+
132+
The node lifecycle APIs enable you to prepare nodes for temporary or permanent shutdown, monitor the shutdown status, and enable a previously shut-down node to resume normal operations.
133+
134+
### [Query rules](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-query_rules)
135+
136+
Query rules enable you to configure per-query rules that are applied at query time to queries that match the specific rule. Query rules are organized into rulesets, collections of query rules that are matched against incoming queries. Query rules are applied using the rule query. If a query matches one or more rules in the ruleset, the query is re-written to apply the rules before searching. This allows pinning documents for only queries that match a specific term.
137+
138+
### [Rollup](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-rollup)
139+
140+
The rollup APIs enable you to create, manage, and retrieve infromation about rollup jobs.
141+
142+
### [Script](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-script)
143+
144+
Use the script support APIs to get a list of supported script contexts and languages. Use the stored script APIs to manage stored scripts and search templates.
145+
146+
### [Search](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-search)
147+
148+
The search APIs enable you to search and aggregate data stored in {{es}} indices and data streams.
149+
150+
### [Search application](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-search_application)
151+
152+
The search applcation APIs enable you to manage tasks and resources related to Search Applications.
153+
154+
### [Searchable snapshots](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-searchable_snapshots)
155+
156+
The searchable snapshots APIs enable you to perform searchable snapshots operations.
157+
158+
### [Security](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-security)
159+
160+
The security APIs enable you to perform security activities, and add, update, retrieve, and remove application privileges, role mappings, and roles. You can also create and update API keys and create and invalidate bearer tokens.
161+
162+
### [Snapshot and restore](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-snapshot)
163+
164+
The snapshot and restore APIs enable you to set up snapshot repositories, manage snapshot backups, and restore snapshots to a running cluster.
165+
166+
### [Snapshot lifecycle management](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-slm)
167+
168+
The snapshot lifecycle management APIs enable you to set up policies to automatically take snapshots and control how long they are retained.
169+
170+
### [SQL](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-sql)
171+
172+
The SQL APIs enable you to run SQL queries on Elasticsearch indices and data streams.
173+
174+
### [Synonyms](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-synonyms)
175+
176+
The synonyms management APIs provide a convenient way to define and manage synonyms in an internal system index. Related synonyms can be grouped in a "synonyms set".
177+
178+
### [Task management](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-tasks)
179+
180+
The task management APIs enable you to retrieve information about tasks or cancel tasks running in a cluster.
181+
182+
### [Text structure](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-text_structure)
183+
184+
The text structure APIs enable you to find the structure of a text field in an {{es}} index.
185+
186+
### [Transform](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-transform)
187+
188+
The transform APIs enable you to create and manage transforms.
189+
190+
### [Usage](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-xpack)
191+
192+
The usage API provides usage information about the installed X-Pack features.
193+
194+
### [Watcher](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-watcher)
195+
196+
You can use Watcher to watch for changes or anomalies in your data and perform the necessary actions in response.

0 commit comments

Comments
 (0)