Skip to content

Commit cc93032

Browse files
georgewallacegeorgewallace
committed
updating links
1 parent c68c942 commit cc93032

File tree

1 file changed

+73
-45
lines changed
  • docs/reference/elasticsearch/rest-apis

1 file changed

+73
-45
lines changed

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

Lines changed: 73 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -25,21 +25,25 @@ The autoscaling APIs enable you to create and manage autoscaling policies and re
2525

2626
| API | Description |
2727
| --- | ----------- |
28-
| [Get Autoscaling Capacity](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/autoscaling.get_autoscaling_capacity) | Estimates autoscaling capacity for current cluster state. |
29-
| [Put Autoscaling Policy](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/autoscaling.put_autoscaling_policy) | Creates or updates an autoscaling policy. |
30-
| [Delete Autoscaling Policy](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/autoscaling.delete_autoscaling_policy) | Deletes an existing autoscaling policy. |
31-
| [Get Autoscaling Policy](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/autoscaling.get_autoscaling_policy) | Retrieves a specific autoscaling policy. |
28+
| [Get Autoscaling Policy](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-get-autoscaling-policy) | Retrieves a specific autoscaling policy. |
29+
| [Create or update an autoscaling policy](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-put-autoscaling-policy) | Creates or updates an autoscaling policy. |
30+
| [Delete Autoscaling Policy](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-delete-autoscaling-policy) | Deletes an existing autoscaling policy. |
31+
| [Get Autoscaling Capacity](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-get-autoscaling-capacity) | Estimates autoscaling capacity for current cluster state. |
3232

3333
### [Behavioral analytics](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-analytics)
3434

35+
```{applies_to}
36+
stack: deprecated
37+
```
38+
3539
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.
3640

3741
| API | Description |
3842
| --- | ----------- |
39-
| [Get Collections](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/behavioral_analytics.get_behavioral_analytics) | Lists all behavioral analytics collections. |
40-
| [Create Collection](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/behavioral_analytics.put_behavioral_analytics) | Creates a new behavioral analytics collection. |
41-
| [Delete Collection](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/behavioral_analytics.delete_behavioral_analytics) | Deletes a behavioral analytics collection. |
42-
| [Create Event](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/behavioral_analytics.post_behavioral_analytics_event) | Sends a behavioral analytics event to a collection. |
43+
| [Get Collections](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get-behavioral-analytics) | Lists all behavioral analytics collections. |
44+
| [Create Collection](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-put-behavioral-analytics) | Creates a new behavioral analytics collection. |
45+
| [Delete Collection](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-delete-behavioral-analytics) | Deletes a behavioral analytics collection. |
46+
| [Create Event](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-post-behavioral-analytics-event) | Sends a behavioral analytics event to a collection. |
4347

4448
### [Compact and aligned text (CAT)](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-cat)
4549

@@ -48,7 +52,9 @@ The compact and aligned text (CAT) APIs return human-readable text as a response
4852

4953
| API | Description |
5054
| --- | ----------- |
51-
| [Cat Indices](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/cat.indices) | Lists index stats in a compact, human-readable format. |
55+
| [Cat aliases](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-aliases) | Get the cluster's index aliases, including filter and routing information in a compact, human-readable format. |
56+
| [Cat allocation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-allocation) | Provides a snapshot of the number of shards allocated to each data node and their disk space in a compact, human-readable format. |
57+
| [Cat Indices](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-indices) | Lists index stats in a compact, human-readable format. |
5258
| [Cat Nodes](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/cat.nodes) | Shows node-level metrics like CPU, memory, and roles. |
5359
| [Cat Shards](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/cat.shards) | Displays shard allocation across nodes. |
5460
| [Cat Health](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/cat.health) | Provides a snapshot of cluster health. |
@@ -451,85 +457,107 @@ The snapshot lifecycle management APIs enable you to set up policies to automati
451457

452458
| API | Description |
453459
| --- | ----------- |
454-
| [Put SLM Policy](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/slm.put_lifecycle) | Creates or updates a snapshot lifecycle policy. |
455-
| [Get SLM Policy](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/slm.get_lifecycle) | Retrieves one or more snapshot lifecycle policies. |
456-
| [Delete SLM Policy](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/slm.delete_lifecycle) | Deletes a snapshot lifecycle policy. |
457-
| [Execute SLM Policy](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/slm.execute_lifecycle) | Triggers a snapshot lifecycle policy manually. |
458-
| [Get SLM Stats](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/slm.get_stats) | Returns statistics about snapshot lifecycle executions. |
459-
| [Get SLM Status](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/slm.get_status) | Returns the status of the snapshot lifecycle management feature. |
460-
| [Start SLM](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/slm.start) | Starts the snapshot lifecycle management feature. |
461-
| [Stop SLM](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/slm.stop) | Stops the snapshot lifecycle management feature. |
460+
| [Get policy information](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-get-lifecycle) | Retrieves one or more snapshot lifecycle policies. |
461+
| [Create or update a policy](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-put-lifecycle) | Creates or updates a snapshot lifecycle policy. |
462+
| [Delete a policy](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-delete-lifecycle) | Deletes a snapshot lifecycle policy. |
463+
| [Run a policy](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-execute-lifecycle) | Triggers a snapshot lifecycle policy manually. |
464+
| [Run a retention policy](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-execute-retention) | Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. |
465+
| [Get snapshot lifecycle management statistics](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-get-stats) | Returns statistics about snapshot lifecycle executions. |
466+
| [https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-get-status](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-get-status) | Returns the status of the snapshot lifecycle management feature. |
467+
| [Start snapshot lifecycle management](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-start) | Starts the snapshot lifecycle management feature. |
468+
| [Stop snapshot lifecycle management](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-stop) | Stops the snapshot lifecycle management feature. |
462469

463470
### [SQL](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-sql)
464471

465472
The SQL APIs enable you to run SQL queries on Elasticsearch indices and data streams.
466473

467474
| API | Description |
468475
| --- | ----------- |
469-
| [SQL Query](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/sql.query) | Executes an SQL query. |
470-
| [SQL Translate](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/sql.translate) | Translates SQL into Elasticsearch DSL. |
471-
| [SQL Async Query](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/sql.async_query) | Submits an SQL query to run asynchronously. |
472-
| [SQL Async Get](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/sql.get_async) | Retrieves results of an async SQL query. |
473-
| [SQL Async Delete](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/sql.delete_async) | Cancels an async SQL query. |
476+
| [Clear a SQL search cursor](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-clear-cursor) | |
477+
| [Delete an async SQL search](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-delete-async) | |
478+
| [Get async SQL search results](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-get-async) | Retrieves results of an async SQL query. |
479+
| [Get the async SQL search status](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-get-async-status) | Get the current status of an async SQL search or a stored synchronous SQL search. |
480+
| [Get SQL search results](hhttps://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-query) | Executes an SQL query. |
481+
| [SQL Translate](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-translate) | Translates SQL into Elasticsearch DSL. |
482+
| [Translate SQL into Elasticsearch queries](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/sql.async_query) | Submits an SQL query to run asynchronously. |
474483

475484
### [Synonyms](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-synonyms)
476485

477486
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".
478487

479488
| API | Description |
480489
| --- | ----------- |
481-
| [Put Synonym Set](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/synonyms.put_synonym) | Creates or updates a synonym set. |
482-
| [Get Synonym Set](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/synonyms.get_synonym) | Retrieves a synonym set by ID. |
483-
| [Delete Synonym Set](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/synonyms.delete_synonym) | Deletes a synonym set. |
484-
| [List Synonym Sets](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/synonyms.get_synonyms) | Lists all synonym sets. |
490+
| [Get synonym set](hthttps://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym) | Retrieves a synonym set by ID. |
491+
| [Create of update synonym set](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-put-synonym) | Creates or updates a synonym set. |
492+
| [Delete synonym set](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/synonyms.delete_synonym) | Deletes a synonym set. |
493+
| [Get synonym rule](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym-rule) | |
494+
| [Get synonym sets](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/synonyms.get_synonyms) | Lists all synonym sets. |
485495

486496
### [Task management](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-tasks)
487497

488498
The task management APIs enable you to retrieve information about tasks or cancel tasks running in a cluster.
489499

490-
491500
| API | Description |
492501
| --- | ----------- |
493-
| [List Tasks](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/tasks.list) | Retrieves information about running tasks. |
494-
| [Cancel Task](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/tasks.cancel) | Cancels a running task. |
502+
| [Cancel a task](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-tasks-cancel) | Cancels a running task. |
503+
| [Get task information](https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-tasks-get) | Cancels a running task. |
504+
| [Get all tasks](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-tasks-list) | Retrieves information about running tasks. |
495505

496506
### [Text structure](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-text_structure)
497507

498508
The text structure APIs enable you to find the structure of a text field in an {{es}} index.
499509

500-
501510
| API | Description |
502511
| --- | ----------- |
503-
| [Find Structure](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/text_structure.find_structure) | Analyzes a text file and returns its structure. |
512+
| [Find the structure of a text field](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-find-field-structure) | |
513+
| [Find the structure of a text message](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-find-message-structure) | |
514+
| [Find the structure of a text file](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-find-structure) | Analyzes a text file and returns its structure. |
515+
| [Test a Grok pattern](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-test-grok-pattern) | |
504516

505517
### [Transform](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-transform)
506518

507519
The transform APIs enable you to create and manage transforms.
508520

509521
| API | Description |
510522
| --- | ----------- |
511-
| [Put Transform](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/transform.put_transform) | Creates or updates a transform job. |
512-
| [Get Transform](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/transform.get_transform) | Retrieves configuration for one or more transforms. |
513-
| [Delete Transform](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/transform.delete_transform) | Deletes a transform job. |
514-
| [Start Transform](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/transform.start_transform) | Starts a transform job. |
515-
| [Stop Transform](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/transform.stop_transform) | Stops a running transform job. |
516-
| [Preview Transform](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/transform.preview_transform) | Previews the results of a transform job. |
523+
| [Get transforms](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-get-transform) | Retrieves configuration for one or more transforms. |
524+
| [Create a transform](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-put-transform) | Creates or updates a transform job. |
525+
| [Get transform stats](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-get-transform-stats) | |
526+
| [Preview transform](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-preview-transform) | Previews the results of a transform job. |
527+
| [Reset a transform](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-reset-transform) | Previews the results of a transform job. |
528+
| [Delete transform](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-delete-transform) | Deletes a transform job. |
529+
| [Schedule a transform](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-schedule-now-transform) | Previews the results of a transform job. |
530+
| [Start transform](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-start-transform) | Starts a transform job. |
531+
| [Stop transform](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-stop-transform) | Stops a running transform job. |
532+
| [Update transform](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-update-transform) | Updates certain properties of a transform. |
533+
| [Upgrade all transforms](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-upgrade-transforms) | Updates certain properties of a transform. |
517534

518535
### [Usage](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-xpack)
519536

520537
The usage API provides usage information about the installed X-Pack features.
521538

539+
| API | Description |
540+
| --- | ----------- |
541+
| [Get information](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-xpack-info) | |
542+
| [Get usage information](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-xpack-usage) | |
543+
544+
522545
### [Watcher](https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-watcher)
523546

524547
You can use Watcher to watch for changes or anomalies in your data and perform the necessary actions in response.
525548

526549
| API | Description |
527550
| --- | ----------- |
528-
| [Put Watch](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/watcher.put_watch) | Creates or updates a watch. |
529-
| [Get Watch](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/watcher.get_watch) | Retrieves a watch by ID. |
530-
| [Delete Watch](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/watcher.delete_watch) | Deletes a watch. |
531-
| [Execute Watch](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/watcher.execute_watch) | Executes a watch manually. |
532-
| [Ack Watch](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/watcher.ack_watch) | Acknowledges a watch action. |
533-
| [Watcher Stats](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/watcher.stats) | Returns statistics about the Watcher service. |
534-
| [Start Watcher](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/watcher.start) | Starts the Watcher service. |
535-
| [Stop Watcher](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/watcher.stop) | Stops the Watcher service. |
551+
| [Acknowledge a watch](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/watcher.ack_watch) | Acknowledges a watch action. |
552+
| [Activate a watch](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-activate-watch) | Activates a watch. |
553+
| [Deactivates a watch](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-deactivate-watch) | Activates a watch. |
554+
| [Get a watch](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-get-watch) | Retrieves a watch by ID. |
555+
| [Create or update a watch](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-put-watch) | Creates or updates a watch. |
556+
| [Delete a watch](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/watcher.delete_watch) | Deletes a watch. |
557+
| [Run a watch](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/watcher.execute_watch) | Executes a watch manually. |
558+
| [Get Watcher index settings](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-get-settings) | |
559+
| [Update Watcher index settings](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-update-settings) | |
560+
| [Query watches](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-query-watches) | |
561+
| [Start the watch service](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/watcher.start) | Starts the Watcher service. |
562+
| [Get Watcher statistics](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/watcher.stats) | Returns statistics about the Watcher service. |
563+
| [Stop the watch service](https://www.elastic.co/docs/api/doc/elasticsearch/endpoint/watcher.stop) | Stops the Watcher service. |

0 commit comments

Comments
 (0)