diff --git a/API_STYLE_GUIDE.md b/API_STYLE_GUIDE.md index a058bbe7c2..fbe1febff9 100644 --- a/API_STYLE_GUIDE.md +++ b/API_STYLE_GUIDE.md @@ -31,13 +31,13 @@ The following sections describe the basic API documentation structure. Each sect Depending on where the documentation appears within a section or subsection, heading levels may be adjusted to fit with other content. 1. Name of API (heading level 2) -1. (Optional) Path and HTTP methods (heading level 3) -1. Path parameters (heading level 3) -1. Query parameters (heading level 3) -1. Request fields (heading level 3) +1. Endpoints (heading level 3) +1. (Optional) Path parameters (heading level 3) +1. (Optional) Query parameters (heading level 3) +1. (Optional) Request fields (heading level 3) 1. Example request (heading level 4) -1. Example response (heading level 4) -1. Response fields (heading level 3) +1. (Optional) Example response (heading level 4) +1. (Optional) Response fields (heading level 3) ## API name @@ -55,7 +55,7 @@ If applicable, provide any caveats to its usage with a note or tip, as in the fo "If you use the Security plugin, make sure you have the appropriate permissions." (To set this point in note-style format, follow the text on the next line with {: .note}) -### Path and HTTP methods +### Endpoints For relatively complex API calls that include path parameters, it's sometimes a good idea to provide an example so that users can visualize how the request is properly formed. This section is optional and includes examples that illustrate how the endpoint and path parameters fit together in the request. The following is an example of this section for the nodes stats API: diff --git a/_api-reference/analyze-apis.md b/_api-reference/analyze-apis.md index 5a63f665d9..798e51e630 100644 --- a/_api-reference/analyze-apis.md +++ b/_api-reference/analyze-apis.md @@ -20,7 +20,7 @@ The Analyze API analyzes a text string and returns the resulting tokens. If you use the Security plugin, you must have the `manage index` privilege. If you only want to analyze text, you must have the `manage cluster` privilege. {: .note} -## Path and HTTP methods +## Endpoints ```json GET /_analyze diff --git a/_api-reference/cat/cat-aliases.md b/_api-reference/cat/cat-aliases.md index 950d497351..5a6e3e2692 100644 --- a/_api-reference/cat/cat-aliases.md +++ b/_api-reference/cat/cat-aliases.md @@ -16,7 +16,7 @@ has_children: false The CAT aliases operation lists the mapping of aliases to indexes, plus routing and filtering information. -## Path and HTTP methods +## Endpoints ```json GET _cat/aliases/ diff --git a/_api-reference/cat/cat-allocation.md b/_api-reference/cat/cat-allocation.md index a57c861a4b..c28a35afcc 100644 --- a/_api-reference/cat/cat-allocation.md +++ b/_api-reference/cat/cat-allocation.md @@ -15,7 +15,7 @@ has_children: false The CAT allocation operation lists the allocation of disk space for indexes and the number of shards on each node. -## Path and HTTP methods +## Endpoints ```json GET _cat/allocation?v diff --git a/_api-reference/cat/cat-cluster_manager.md b/_api-reference/cat/cat-cluster_manager.md index 1b75074e12..21b2684817 100644 --- a/_api-reference/cat/cat-cluster_manager.md +++ b/_api-reference/cat/cat-cluster_manager.md @@ -15,7 +15,7 @@ has_children: false The CAT cluster manager operation lists information that helps identify the elected cluster manager node. -## Path and HTTP methods +## Endpoints ```json GET _cat/cluster_manager diff --git a/_api-reference/cat/cat-count.md b/_api-reference/cat/cat-count.md index 94a422d061..fa50ce1d0f 100644 --- a/_api-reference/cat/cat-count.md +++ b/_api-reference/cat/cat-count.md @@ -16,7 +16,7 @@ redirect_from: The CAT count operation lists the number of documents in your cluster. -## Path and HTTP methods +## Endpoints ```json GET _cat/count?v diff --git a/_api-reference/cat/cat-field-data.md b/_api-reference/cat/cat-field-data.md index 3012bbbfe9..4a7e30642f 100644 --- a/_api-reference/cat/cat-field-data.md +++ b/_api-reference/cat/cat-field-data.md @@ -15,7 +15,7 @@ redirect_from: The CAT Field Data operation lists the memory size used by each field per node. -## Path and HTTP methods +## Endpoints ```json GET _cat/fielddata?v diff --git a/_api-reference/cat/cat-health.md b/_api-reference/cat/cat-health.md index 0e4b784693..49bdec3b0a 100644 --- a/_api-reference/cat/cat-health.md +++ b/_api-reference/cat/cat-health.md @@ -16,7 +16,7 @@ redirect_from: The CAT health operation lists the status of the cluster, how long the cluster has been up, the number of nodes, and other useful information that helps you analyze the health of your cluster. -## Path and HTTP methods +## Endpoints ```json GET _cat/health?v diff --git a/_api-reference/cat/cat-indices.md b/_api-reference/cat/cat-indices.md index 4bbdde573c..c061c8fa17 100644 --- a/_api-reference/cat/cat-indices.md +++ b/_api-reference/cat/cat-indices.md @@ -15,7 +15,7 @@ redirect_from: The CAT indices operation lists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on. -## Path and HTTP methods +## Endpoints ```json GET _cat/indices/ diff --git a/_api-reference/cat/cat-nodeattrs.md b/_api-reference/cat/cat-nodeattrs.md index 62471f3960..1aa4f32640 100644 --- a/_api-reference/cat/cat-nodeattrs.md +++ b/_api-reference/cat/cat-nodeattrs.md @@ -15,7 +15,7 @@ redirect_from: The CAT nodeattrs operation lists the attributes of custom nodes. -## Path and HTTP methods +## Endpoints ```json GET _cat/nodeattrs diff --git a/_api-reference/cat/cat-nodes.md b/_api-reference/cat/cat-nodes.md index d20393a251..1a892ab0d9 100644 --- a/_api-reference/cat/cat-nodes.md +++ b/_api-reference/cat/cat-nodes.md @@ -17,7 +17,7 @@ The CAT nodes operation lists node-level information, including node roles and l A few important node metrics are `pid`, `name`, `cluster_manager`, `ip`, `port`, `version`, `build`, `jdk`, along with `disk`, `heap`, `ram`, and `file_desc`. -## Path and HTTP methods +## Endpoints ```json GET _cat/nodes diff --git a/_api-reference/cat/cat-pending-tasks.md b/_api-reference/cat/cat-pending-tasks.md index b047dd5d62..370ed09597 100644 --- a/_api-reference/cat/cat-pending-tasks.md +++ b/_api-reference/cat/cat-pending-tasks.md @@ -16,7 +16,7 @@ redirect_from: The CAT pending tasks operation lists the progress of all pending tasks, including task priority and time in queue. -## Path and HTTP methods +## Endpoints ```json GET _cat/pending_tasks diff --git a/_api-reference/cat/cat-plugins.md b/_api-reference/cat/cat-plugins.md index 45866e8ebd..f4e540be14 100644 --- a/_api-reference/cat/cat-plugins.md +++ b/_api-reference/cat/cat-plugins.md @@ -16,7 +16,7 @@ redirect_from: The CAT plugins operation lists the names, components, and versions of the installed plugins. -## Path and HTTP methods +## Endpoints ```json GET _cat/plugins diff --git a/_api-reference/cat/cat-recovery.md b/_api-reference/cat/cat-recovery.md index fc29e14ac6..f568fa46b3 100644 --- a/_api-reference/cat/cat-recovery.md +++ b/_api-reference/cat/cat-recovery.md @@ -16,7 +16,7 @@ redirect_from: The CAT recovery operation lists all completed and ongoing index and shard recoveries. -## Path and HTTP methods +## Endpoints ```json GET _cat/recovery diff --git a/_api-reference/cat/cat-repositories.md b/_api-reference/cat/cat-repositories.md index c197ee5c6c..fb7bb9a78c 100644 --- a/_api-reference/cat/cat-repositories.md +++ b/_api-reference/cat/cat-repositories.md @@ -15,7 +15,7 @@ redirect_from: The CAT repositories operation lists all snapshot repositories for a cluster. -## Path and HTTP methods +## Endpoints ```json GET _cat/repositories diff --git a/_api-reference/cat/cat-segment-replication.md b/_api-reference/cat/cat-segment-replication.md index e943d0a451..ba1a5dd67e 100644 --- a/_api-reference/cat/cat-segment-replication.md +++ b/_api-reference/cat/cat-segment-replication.md @@ -15,7 +15,7 @@ The CAT segment replication operation returns information about active and last Call the CAT Segment Replication API only on indexes with segment replication enabled. {: .note} -## Path and HTTP methods +## Endpoints ```json GET /_cat/segment_replication diff --git a/_api-reference/cat/cat-segments.md b/_api-reference/cat/cat-segments.md index 76696d3886..7ed54f646b 100644 --- a/_api-reference/cat/cat-segments.md +++ b/_api-reference/cat/cat-segments.md @@ -16,7 +16,7 @@ redirect_from: The cat segments operation lists Lucene segment-level information for each index. -## Path and HTTP methods +## Endpoints ```json GET _cat/segments diff --git a/_api-reference/cat/cat-shards.md b/_api-reference/cat/cat-shards.md index c9677cb0ed..800eaa66d3 100644 --- a/_api-reference/cat/cat-shards.md +++ b/_api-reference/cat/cat-shards.md @@ -16,7 +16,7 @@ redirect_from: The CAT shards operation lists the state of all primary and replica shards and how they are distributed. -## Path and HTTP methods +## Endpoints ```json GET _cat/shards diff --git a/_api-reference/cat/cat-snapshots.md b/_api-reference/cat/cat-snapshots.md index 71c3b3f75d..9fd5394779 100644 --- a/_api-reference/cat/cat-snapshots.md +++ b/_api-reference/cat/cat-snapshots.md @@ -16,7 +16,7 @@ redirect_from: The CAT snapshots operation lists all snapshots for a repository. -## Path and HTTP methods +## Endpoints ```json GET _cat/snapshots diff --git a/_api-reference/cat/cat-tasks.md b/_api-reference/cat/cat-tasks.md index 5419d5c647..4b2de14e40 100644 --- a/_api-reference/cat/cat-tasks.md +++ b/_api-reference/cat/cat-tasks.md @@ -15,7 +15,7 @@ redirect_from: The CAT tasks operation lists the progress of all tasks currently running on your cluster. -## Path and HTTP methods +## Endpoints ```json GET _cat/tasks diff --git a/_api-reference/cat/cat-templates.md b/_api-reference/cat/cat-templates.md index 90b7d43fc7..5570094058 100644 --- a/_api-reference/cat/cat-templates.md +++ b/_api-reference/cat/cat-templates.md @@ -16,7 +16,7 @@ redirect_from: The CAT templates operation lists the names, patterns, order numbers, and version numbers of index templates. -## Path and HTTP methods +## Endpoints ```json GET _cat/templates diff --git a/_api-reference/cat/cat-thread-pool.md b/_api-reference/cat/cat-thread-pool.md index 3171ae830e..39df7a2010 100644 --- a/_api-reference/cat/cat-thread-pool.md +++ b/_api-reference/cat/cat-thread-pool.md @@ -15,7 +15,7 @@ redirect_from: The CAT thread pool operation lists the active, queued, and rejected threads of different thread pools on each node. -## Path and HTTP methods +## Endpoints ```json GET _cat/thread_pool diff --git a/_api-reference/cluster-api/cluster-allocation.md b/_api-reference/cluster-api/cluster-allocation.md index 2f8bd9799c..5e7984cd75 100644 --- a/_api-reference/cluster-api/cluster-allocation.md +++ b/_api-reference/cluster-api/cluster-allocation.md @@ -17,7 +17,7 @@ The most basic cluster allocation explain request finds an unassigned shard and If you add some options, you can instead get information on a specific shard, including why OpenSearch assigned it to its current node. -## Path and HTTP methods +## Endpoints ```json GET _cluster/allocation/explain diff --git a/_api-reference/cluster-api/cluster-awareness.md b/_api-reference/cluster-api/cluster-awareness.md index 8c162f214c..4be9f50947 100644 --- a/_api-reference/cluster-api/cluster-awareness.md +++ b/_api-reference/cluster-api/cluster-awareness.md @@ -15,7 +15,7 @@ redirect_from: To control the distribution of search or HTTP traffic, you can use the weights per awareness attribute to control the distribution of search or HTTP traffic across zones. This is commonly used for zonal deployments, heterogeneous instances, and routing traffic away from zones during zonal failure. -## Path and HTTP methods +## Endpoints ```json PUT /_cluster/routing/awareness//weights diff --git a/_api-reference/cluster-api/cluster-decommission.md b/_api-reference/cluster-api/cluster-decommission.md index 1cf17c5b6b..04d73d329d 100644 --- a/_api-reference/cluster-api/cluster-decommission.md +++ b/_api-reference/cluster-api/cluster-decommission.md @@ -18,7 +18,7 @@ The cluster decommission operation adds support decommissioning based on awarene For more information about allocation awareness, see [Shard allocation awareness]({{site.url}}{{site.baseurl}}//opensearch/cluster/#shard-allocation-awareness). -## Path and HTTP methods +## Endpoints ```json PUT /_cluster/decommission/awareness/{awareness_attribute_name}/{awareness_attribute_value} diff --git a/_api-reference/cluster-api/cluster-health.md b/_api-reference/cluster-api/cluster-health.md index df8f3f24e3..07ba8d4364 100644 --- a/_api-reference/cluster-api/cluster-health.md +++ b/_api-reference/cluster-api/cluster-health.md @@ -18,7 +18,7 @@ The most basic cluster health request returns a simple status of the health of y To get the status of a specific index, provide the index name. -## Path and HTTP methods +## Endpoints ```json GET _cluster/health diff --git a/_api-reference/cluster-api/cluster-settings.md b/_api-reference/cluster-api/cluster-settings.md index 1e0977c56a..9008234ff6 100644 --- a/_api-reference/cluster-api/cluster-settings.md +++ b/_api-reference/cluster-api/cluster-settings.md @@ -14,7 +14,7 @@ redirect_from: The cluster settings operation lets you check the current settings for your cluster, review default settings, and change settings. When you update a setting using the API, OpenSearch applies it to all nodes in the cluster. -## Path and HTTP methods +## Endpoints ```json GET _cluster/settings diff --git a/_api-reference/cluster-api/cluster-stats.md b/_api-reference/cluster-api/cluster-stats.md index 0a1b348a67..5d0d9c6d95 100644 --- a/_api-reference/cluster-api/cluster-stats.md +++ b/_api-reference/cluster-api/cluster-stats.md @@ -16,7 +16,7 @@ redirect_from: The cluster stats API operation returns statistics about your cluster. -## Path and HTTP methods +## Endpoints ```json GET _cluster/stats diff --git a/_api-reference/count.md b/_api-reference/count.md index 048dad9609..2e0d4dd1c7 100644 --- a/_api-reference/count.md +++ b/_api-reference/count.md @@ -14,7 +14,7 @@ The count API gives you quick access to the number of documents that match a que You can also use it to check the document count of an index, data stream, or cluster. -## Path and HTTP methods +## Endpoints ```json GET /_count/ diff --git a/_api-reference/document-apis/bulk-streaming.md b/_api-reference/document-apis/bulk-streaming.md index c127eab527..f9379b700e 100644 --- a/_api-reference/document-apis/bulk-streaming.md +++ b/_api-reference/document-apis/bulk-streaming.md @@ -19,7 +19,7 @@ The streaming bulk operation lets you add, update, or delete multiple documents The default HTTP transport method does not support streaming. You must install the [`transport-reactor-netty4`]({{site.url}}{{site.baseurl}}/install-and-configure/configuring-opensearch/network-settings/#selecting-the-transport) HTTP transport plugin and use it as the default HTTP transport layer. Both the `transport-reactor-netty4` plugin and the Streaming Bulk API are experimental. {: .note} -## Path and HTTP methods +## Endpoints ```json POST _bulk/stream diff --git a/_api-reference/document-apis/bulk.md b/_api-reference/document-apis/bulk.md index 2a2a5ef8a2..78b8627afb 100644 --- a/_api-reference/document-apis/bulk.md +++ b/_api-reference/document-apis/bulk.md @@ -19,7 +19,7 @@ Beginning in OpenSearch 2.9, when indexing documents using the bulk operation, t -## Path and HTTP methods +## Endpoints ```json POST _bulk diff --git a/_api-reference/document-apis/delete-by-query.md b/_api-reference/document-apis/delete-by-query.md index a55617e145..2bfa1c333a 100644 --- a/_api-reference/document-apis/delete-by-query.md +++ b/_api-reference/document-apis/delete-by-query.md @@ -13,7 +13,7 @@ redirect_from: You can include a query as part of your delete request so OpenSearch deletes all documents that match that query. -## Path and HTTP methods +## Endpoints ```json POST /_delete_by_query diff --git a/_api-reference/document-apis/delete-document.md b/_api-reference/document-apis/delete-document.md index 85ce4bd79b..fc41e1e3e0 100644 --- a/_api-reference/document-apis/delete-document.md +++ b/_api-reference/document-apis/delete-document.md @@ -13,7 +13,7 @@ redirect_from: If you no longer need a document in your index, you can use the delete document API operation to delete it. -## Path and HTTP methods +## Endpoints ```json DELETE //_doc/<_id> diff --git a/_api-reference/document-apis/get-documents.md b/_api-reference/document-apis/get-documents.md index 1a6bc73a12..7031451224 100644 --- a/_api-reference/document-apis/get-documents.md +++ b/_api-reference/document-apis/get-documents.md @@ -14,7 +14,7 @@ redirect_from: After adding a JSON document to your index, you can use the Get Document API operation to retrieve the document's information and data. -## Path and HTTP methods +## Endpoints Use the GET method to retrieve a document and its source or stored fields from a particular index. Use the HEAD method to verify that a document exists: diff --git a/_api-reference/document-apis/index-document.md b/_api-reference/document-apis/index-document.md index d195a0662e..4666581f31 100644 --- a/_api-reference/document-apis/index-document.md +++ b/_api-reference/document-apis/index-document.md @@ -14,7 +14,7 @@ redirect_from: You can use the `Index document` operation to add a single document to your index. -## Path and HTTP methods +## Endpoints ```json PUT /_doc/<_id> diff --git a/_api-reference/document-apis/multi-get.md b/_api-reference/document-apis/multi-get.md index acd69a7b7e..fa706b6fb5 100644 --- a/_api-reference/document-apis/multi-get.md +++ b/_api-reference/document-apis/multi-get.md @@ -13,7 +13,7 @@ redirect_from: The multi-get operation allows you to run multiple GET operations in one request, so you can get back all documents that match your criteria. -## Path and HTTP methods +## Endpoints ```json GET _mget diff --git a/_api-reference/document-apis/reindex.md b/_api-reference/document-apis/reindex.md index 65df81777e..df71befcad 100644 --- a/_api-reference/document-apis/reindex.md +++ b/_api-reference/document-apis/reindex.md @@ -15,7 +15,7 @@ redirect_from: The reindex document API operation lets you copy all or a subset of your data from a source index into a destination index. -## Path and HTTP methods +## Endpoints ```json POST /_reindex diff --git a/_api-reference/document-apis/update-by-query.md b/_api-reference/document-apis/update-by-query.md index 64df8c901b..9e08597fd1 100644 --- a/_api-reference/document-apis/update-by-query.md +++ b/_api-reference/document-apis/update-by-query.md @@ -14,7 +14,7 @@ redirect_from: You can include a query and a script as part of your update request so OpenSearch can run the script to update all of the documents that match the query. -## Path and HTTP methods +## Endpoints ```json POST , /_update_by_query diff --git a/_api-reference/document-apis/update-document.md b/_api-reference/document-apis/update-document.md index ff17940cdb..c7f6b63558 100644 --- a/_api-reference/document-apis/update-document.md +++ b/_api-reference/document-apis/update-document.md @@ -14,7 +14,7 @@ redirect_from: If you need to update a document's fields in your index, you can use the update document API operation. You can do so by specifying the new data you want to be in your index or by including a script in your request body, which OpenSearch runs to update the document. By default, the update operation only updates a document that exists in the index. If a document does not exist, the API returns an error. To _upsert_ a document (update the document that exists or index a new one), use the [upsert](#using-the-upsert-operation) operation. -## Path and HTTP methods +## Endpoints ```json POST //_update/<_id> diff --git a/_api-reference/explain.md b/_api-reference/explain.md index 0591c5bb52..184b6d8bf3 100644 --- a/_api-reference/explain.md +++ b/_api-reference/explain.md @@ -18,7 +18,7 @@ The explain API is an expensive operation in terms of both resources and time. O {: .warning } -## Path and HTTP methods +## Endpoints ```json GET /_explain/ diff --git a/_api-reference/index-apis/alias.md b/_api-reference/index-apis/alias.md index c3ddf76911..d90fdf606d 100644 --- a/_api-reference/index-apis/alias.md +++ b/_api-reference/index-apis/alias.md @@ -15,7 +15,7 @@ redirect_from: An alias is a virtual pointer that you can use to reference one or more indexes. Creating and updating aliases are atomic operations, so you can reindex your data and point an alias at it without any downtime. -## Path and HTTP methods +## Endpoints ```json POST _aliases diff --git a/_api-reference/index-apis/blocks.md b/_api-reference/index-apis/blocks.md index 61b0e1ddd6..21edaebc16 100644 --- a/_api-reference/index-apis/blocks.md +++ b/_api-reference/index-apis/blocks.md @@ -12,7 +12,7 @@ nav_order: 6 Use the Blocks API to limit certain operations on a specified index. Different types of blocks allow you to restrict index write, read, or metadata operations. For example, adding a `write` block through the API ensures that all index shards have properly accounted for the block before returning a successful response. Any in-flight write operations to the index must be complete before the `write` block takes effect. -## Path and HTTP methods +## Endpoints ```json PUT //_block/ diff --git a/_api-reference/index-apis/clear-index-cache.md b/_api-reference/index-apis/clear-index-cache.md index 6227a29960..7b713fa15d 100644 --- a/_api-reference/index-apis/clear-index-cache.md +++ b/_api-reference/index-apis/clear-index-cache.md @@ -15,7 +15,7 @@ The clear cache API operation clears the caches of one or more indexes. For data If you use the Security plugin, you must have the `manage index` privileges. {: .note} -## Path and HTTP methods +## Endpoints ```json POST //_cache/clear diff --git a/_api-reference/index-apis/clone.md b/_api-reference/index-apis/clone.md index 36592a28b5..9076e06ed8 100644 --- a/_api-reference/index-apis/clone.md +++ b/_api-reference/index-apis/clone.md @@ -13,7 +13,7 @@ redirect_from: The clone index API operation clones all data in an existing read-only index into a new index. The new index cannot already exist. -## Path and HTTP methods +## Endpoints ```json POST //_clone/ diff --git a/_api-reference/index-apis/close-index.md b/_api-reference/index-apis/close-index.md index ecad7d18cc..ca543cdc5c 100644 --- a/_api-reference/index-apis/close-index.md +++ b/_api-reference/index-apis/close-index.md @@ -14,7 +14,7 @@ redirect_from: The close index API operation closes an index. Once an index is closed, you cannot add data to it or search for any data within the index. -## Path and HTTP methods +## Endpoints ```json POST //_close diff --git a/_api-reference/index-apis/component-template.md b/_api-reference/index-apis/component-template.md index fa73e64c94..4dc736f4c3 100644 --- a/_api-reference/index-apis/component-template.md +++ b/_api-reference/index-apis/component-template.md @@ -15,7 +15,7 @@ If any settings or mappings are directly defined in the index template or the in Component templates are used solely during the process of index creation. For data streams, this includes the creation of the data stream itself and the creation of the backing indexes that support the stream. Modifications made to component templates will not affect existing indexes, including the backing indexes of a data stream. -## Path and HTTP methods +## Endpoints The PUT method adds a component template and accepts both query parameters and a request body. The GET method retrieves information about an existing component template and accepts only query parameters: diff --git a/_api-reference/index-apis/create-index-template.md b/_api-reference/index-apis/create-index-template.md index c2f4228c8e..7f14bb9927 100644 --- a/_api-reference/index-apis/create-index-template.md +++ b/_api-reference/index-apis/create-index-template.md @@ -9,7 +9,7 @@ nav_order: 26 You can use the Create or Update Index Template API to create indexes with predefined mappings and settings as well as update existing index templates. -## Path and HTTP methods +## Endpoints ```json PUT _index_template/ diff --git a/_api-reference/index-apis/create-index.md b/_api-reference/index-apis/create-index.md index f10450bb28..c63d03f9a3 100644 --- a/_api-reference/index-apis/create-index.md +++ b/_api-reference/index-apis/create-index.md @@ -16,7 +16,7 @@ While you can create an index by using a document as a base, you can also create When creating an index, you can specify its mappings, settings, and aliases. -## Path and HTTP methods +## Endpoints ```json PUT diff --git a/_api-reference/index-apis/dangling-index.md b/_api-reference/index-apis/dangling-index.md index f44a9dc4d4..bc33155667 100644 --- a/_api-reference/index-apis/dangling-index.md +++ b/_api-reference/index-apis/dangling-index.md @@ -11,7 +11,7 @@ nav_order: 30 After a node joins a cluster, dangling indexes occur if any shards exist in the node's local directory that do not already exist in the cluster. Dangling indexes can be listed, deleted, or imported. -## Path and HTTP methods +## Endpoints List dangling indexes: diff --git a/_api-reference/index-apis/delete-index-template.md b/_api-reference/index-apis/delete-index-template.md index f6e2f38773..bbc277404f 100644 --- a/_api-reference/index-apis/delete-index-template.md +++ b/_api-reference/index-apis/delete-index-template.md @@ -9,7 +9,7 @@ nav_order: 28 The Delete Index Template API deletes one or more index templates. -## Path and HTTP methods +## Endpoints ```json DELETE /_index_template/ diff --git a/_api-reference/index-apis/delete-index.md b/_api-reference/index-apis/delete-index.md index af0bd292fc..e3b99b1260 100644 --- a/_api-reference/index-apis/delete-index.md +++ b/_api-reference/index-apis/delete-index.md @@ -13,7 +13,7 @@ redirect_from: If you no longer need an index, you can use the delete index API operation to delete it. -## Path and HTTP methods +## Endpoints ```json DELETE / diff --git a/_api-reference/index-apis/exists.md b/_api-reference/index-apis/exists.md index fb1a4d79c6..5fb4b25719 100644 --- a/_api-reference/index-apis/exists.md +++ b/_api-reference/index-apis/exists.md @@ -14,7 +14,7 @@ redirect_from: The index exists API operation returns whether or not an index already exists. -## Path and HTTP methods +## Endpoints ```json HEAD / diff --git a/_api-reference/index-apis/flush.md b/_api-reference/index-apis/flush.md index e464a42cad..b699b4511c 100644 --- a/_api-reference/index-apis/flush.md +++ b/_api-reference/index-apis/flush.md @@ -14,7 +14,7 @@ The Flush API stores all in-memory operations to segments on disk. Operations fl OpenSearch automatically performs flushes in the background based on conditions like transaction log size, which is controlled by the `index.translog.flush_threshold_size` setting. Use the Flush API sparingly, for example, for manual restarts or to free up memory. -## Path and HTTP methods +## Endpoints The Flush API supports the following paths: diff --git a/_api-reference/index-apis/force-merge.md b/_api-reference/index-apis/force-merge.md index 8316c72937..0579e0824e 100644 --- a/_api-reference/index-apis/force-merge.md +++ b/_api-reference/index-apis/force-merge.md @@ -11,7 +11,7 @@ nav_order: 37 The force merge API operation forces a merge on the shards of one or more indexes. For a data stream, the API forces a merge on the shards of the stream's backing index. -## Path and HTTP methods +## Endpoints ```json POST /_forcemerge diff --git a/_api-reference/index-apis/get-index-template.md b/_api-reference/index-apis/get-index-template.md index 7e2d383640..3073861cdb 100644 --- a/_api-reference/index-apis/get-index-template.md +++ b/_api-reference/index-apis/get-index-template.md @@ -9,7 +9,7 @@ nav_order: 27 The Get Index Template API returns information about one or more index templates. -## Path and HTTP methods +## Endpoints ```json GET /_index_template/ diff --git a/_api-reference/index-apis/get-index.md b/_api-reference/index-apis/get-index.md index 78fe7bcd94..7bedff7430 100644 --- a/_api-reference/index-apis/get-index.md +++ b/_api-reference/index-apis/get-index.md @@ -14,7 +14,7 @@ redirect_from: You can use the get index API operation to return information about an index. -## Path and HTTP methods +## Endpoints ```json GET / diff --git a/_api-reference/index-apis/get-settings.md b/_api-reference/index-apis/get-settings.md index 4eebb43272..08c500f05a 100644 --- a/_api-reference/index-apis/get-settings.md +++ b/_api-reference/index-apis/get-settings.md @@ -15,7 +15,7 @@ redirect_from: The get settings API operation returns all the settings in your index. -## Path and HTTP methods +## Endpoints ```json GET /_settings diff --git a/_api-reference/index-apis/open-index.md b/_api-reference/index-apis/open-index.md index 3011507697..472318e3ef 100644 --- a/_api-reference/index-apis/open-index.md +++ b/_api-reference/index-apis/open-index.md @@ -14,7 +14,7 @@ redirect_from: The open index API operation opens a closed index, letting you add or search for data within the index. -## Path and HTTP methods +## Endpoints ```json POST //_open diff --git a/_api-reference/index-apis/put-mapping.md b/_api-reference/index-apis/put-mapping.md index 26bfbae0d9..710b367b3d 100644 --- a/_api-reference/index-apis/put-mapping.md +++ b/_api-reference/index-apis/put-mapping.md @@ -17,7 +17,7 @@ If you want to create or add mappings and fields to an index, you can use the pu You can't use this operation to update mappings that already map to existing data in the index. You must first create a new index with your desired mappings, and then use the [reindex API operation]({{site.url}}{{site.baseurl}}/opensearch/reindex-data) to map all the documents from your old index to the new index. If you don't want any downtime while you re-index your indexes, you can use [aliases]({{site.url}}{{site.baseurl}}/opensearch/index-alias). -## Path and HTTP methods +## Endpoints ```json PUT //_mapping diff --git a/_api-reference/index-apis/recover.md b/_api-reference/index-apis/recover.md index 41f071cf6c..3a04ca58f5 100644 --- a/_api-reference/index-apis/recover.md +++ b/_api-reference/index-apis/recover.md @@ -24,7 +24,7 @@ Shard recovery occurs automatically in the following scenarios: The Recovery API reports solely on completed recoveries for shard copies presently stored in the cluster. It reports only the most recent recovery for each shard copy and does not include historical information about previous recoveries or information about recoveries of shard copies that no longer exist. Consequently, if a shard copy completes a recovery and is subsequently relocated to a different node, then the information about the original recovery is not displayed in the Recovery API. -## Path and HTTP methods +## Endpoints ```json GET /_recovery diff --git a/_api-reference/index-apis/refresh.md b/_api-reference/index-apis/refresh.md index 917ca5d9a9..1bc3fc03d1 100644 --- a/_api-reference/index-apis/refresh.md +++ b/_api-reference/index-apis/refresh.md @@ -20,7 +20,7 @@ After a shard becomes idle, the indexes will not refresh until either the next s To use the Refresh Index API, you must have write access to the indexes you want to refresh. -## Path and HTTP methods +## Endpoints ```json POST /_refresh diff --git a/_api-reference/index-apis/rollover.md b/_api-reference/index-apis/rollover.md index db30a5d7bf..84184864ca 100644 --- a/_api-reference/index-apis/rollover.md +++ b/_api-reference/index-apis/rollover.md @@ -11,7 +11,7 @@ Introduced 1.0 The Rollover Index API creates a new index for a data stream or index alias based on the `wait_for_active_shards` setting. -## Path and HTTP methods +## Endpoints ```json POST //_rollover/ diff --git a/_api-reference/index-apis/segment.md b/_api-reference/index-apis/segment.md index b9625d3b34..8426d5068d 100644 --- a/_api-reference/index-apis/segment.md +++ b/_api-reference/index-apis/segment.md @@ -12,7 +12,7 @@ Introduced 1.0 The Segment API provides details about the Lucene segments within index shards as well as information about the backing indexes of data streams. -## Path and HTTP methods +## Endpoints ```json GET //_segments diff --git a/_api-reference/index-apis/shrink-index.md b/_api-reference/index-apis/shrink-index.md index e3e1c67155..01efc906cf 100644 --- a/_api-reference/index-apis/shrink-index.md +++ b/_api-reference/index-apis/shrink-index.md @@ -14,7 +14,7 @@ redirect_from: The shrink index API operation moves all of your data in an existing index into a new index with fewer primary shards. -## Path and HTTP methods +## Endpoints ```json POST //_shrink/ diff --git a/_api-reference/index-apis/split.md b/_api-reference/index-apis/split.md index b3db4c3340..514939af7f 100644 --- a/_api-reference/index-apis/split.md +++ b/_api-reference/index-apis/split.md @@ -31,7 +31,7 @@ PUT /sample-index1/_split/split-index1 ``` {% include copy-curl.html %} -## Path and HTTP methods +## Endpoints ```json POST //_split/ diff --git a/_api-reference/index-apis/stats.md b/_api-reference/index-apis/stats.md index 728fe7751f..cc7b302dda 100644 --- a/_api-reference/index-apis/stats.md +++ b/_api-reference/index-apis/stats.md @@ -14,7 +14,7 @@ The Index Stats API provides index statistics. For data streams, the API provide When a shard moves to a different node, the shard-level statistics for the shard are cleared. Although the shard is no longer part of the node, the node preserves any node-level statistics to which the shard contributed. {: .note} -## Path and HTTP methods +## Endpoints ```json GET /_stats diff --git a/_api-reference/index-apis/update-alias.md b/_api-reference/index-apis/update-alias.md index c069703bf3..297b05332b 100644 --- a/_api-reference/index-apis/update-alias.md +++ b/_api-reference/index-apis/update-alias.md @@ -15,7 +15,7 @@ The Create or Update Alias API adds one or more indexes to an alias or updates t The Create or Update Alias API is distinct from the [Alias API]({{site.url}}{{site.baseurl}}/opensearch/rest-api/alias/), which supports the addition and removal of aliases and the removal of alias indexes. In contrast, the following API only supports adding or updating an alias without updating the index itself. Each API also uses different request body parameters. {: .note} -## Path and HTTP methods +## Endpoints ```json POST //_alias/ diff --git a/_api-reference/index-apis/update-settings.md b/_api-reference/index-apis/update-settings.md index 3afaaa10d3..24304e6f4d 100644 --- a/_api-reference/index-apis/update-settings.md +++ b/_api-reference/index-apis/update-settings.md @@ -16,7 +16,7 @@ You can use the update settings API operation to update index-level settings. Yo Aside from the static and dynamic index settings, you can also update individual plugins' settings. To get the full list of updatable settings, run `GET /_settings?include_defaults=true`. -## Path and HTTP methods +## Endpoints ```json PUT //_settings diff --git a/_api-reference/list/list-indices.md b/_api-reference/list/list-indices.md index 618413d35c..a4e58cf3dc 100644 --- a/_api-reference/list/list-indices.md +++ b/_api-reference/list/list-indices.md @@ -16,7 +16,7 @@ The list indices operation provides the following index information in a paginat - The number of shards contained in the index. - The index's health status. -## Path and HTTP methods +## Endpoints ```json GET _list/indices diff --git a/_api-reference/list/list-shards.md b/_api-reference/list/list-shards.md index 7111aeb0f2..e9d1ef98f6 100644 --- a/_api-reference/list/list-shards.md +++ b/_api-reference/list/list-shards.md @@ -11,7 +11,7 @@ nav_order: 20 The list shards operation outputs, in a paginated format, the state of all primary and replica shards and how they are distributed. -## Path and HTTP methods +## Endpoints ```json GET _list/shards diff --git a/_api-reference/msearch-template.md b/_api-reference/msearch-template.md index fdebf5bed1..7311c7f1cc 100644 --- a/_api-reference/msearch-template.md +++ b/_api-reference/msearch-template.md @@ -11,7 +11,7 @@ nav_order: 47 The Multi-search Template API runs multiple search template requests in a single API request. -## Path and HTTP methods +## Endpoints The Multi-search Template API uses the following paths: diff --git a/_api-reference/multi-search.md b/_api-reference/multi-search.md index d8ac41ecec..e5c0236b26 100644 --- a/_api-reference/multi-search.md +++ b/_api-reference/multi-search.md @@ -13,7 +13,7 @@ redirect_from: As the name suggests, the multi-search operation lets you bundle multiple search requests into a single request. OpenSearch then executes the searches in parallel, so you get back the response more quickly compared to sending one request per search. OpenSearch executes each search independently, so the failure of one doesn't affect the others. -## Path and HTTP methods +## Endpoints The Multi-search API uses the following paths: diff --git a/_api-reference/nodes-apis/nodes-hot-threads.md b/_api-reference/nodes-apis/nodes-hot-threads.md index 5339903d1e..f3dd0a2cd6 100644 --- a/_api-reference/nodes-apis/nodes-hot-threads.md +++ b/_api-reference/nodes-apis/nodes-hot-threads.md @@ -12,7 +12,7 @@ nav_order: 30 The nodes hot threads endpoint provides information about busy JVM threads for selected cluster nodes. It provides a unique view of the of activity each node. -## Path and HTTP methods +## Endpoints ```json GET /_nodes/hot_threads diff --git a/_api-reference/nodes-apis/nodes-info.md b/_api-reference/nodes-apis/nodes-info.md index a8767cafce..e97f9ed551 100644 --- a/_api-reference/nodes-apis/nodes-info.md +++ b/_api-reference/nodes-apis/nodes-info.md @@ -19,7 +19,7 @@ The nodes info API represents mostly static information about your cluster's nod - Installed plugins -## Path and HTTP methods +## Endpoints ```json GET /_nodes diff --git a/_api-reference/nodes-apis/nodes-reload-secure.md b/_api-reference/nodes-apis/nodes-reload-secure.md index 1ed0eabde4..3609a50a85 100644 --- a/_api-reference/nodes-apis/nodes-reload-secure.md +++ b/_api-reference/nodes-apis/nodes-reload-secure.md @@ -11,7 +11,7 @@ nav_order: 50 The nodes reload secure settings endpoint allows you to change secure settings on a node and reload the secure settings without restarting the node. -## Path and HTTP methods +## Endpoints ```json POST _nodes/reload_secure_settings diff --git a/_api-reference/nodes-apis/nodes-stats.md b/_api-reference/nodes-apis/nodes-stats.md index 604b89969b..ee3274d51c 100644 --- a/_api-reference/nodes-apis/nodes-stats.md +++ b/_api-reference/nodes-apis/nodes-stats.md @@ -11,7 +11,7 @@ nav_order: 20 The nodes stats API returns statistics about your cluster. -## Path and HTTP methods +## Endpoints ```json GET /_nodes/stats diff --git a/_api-reference/nodes-apis/nodes-usage.md b/_api-reference/nodes-apis/nodes-usage.md index 1101b2989a..f61544764c 100644 --- a/_api-reference/nodes-apis/nodes-usage.md +++ b/_api-reference/nodes-apis/nodes-usage.md @@ -11,7 +11,7 @@ nav_order: 40 The nodes usage endpoint returns low-level information about REST action usage on nodes. -## Path and HTTP methods +## Endpoints ```json GET _nodes/usage diff --git a/_api-reference/profile.md b/_api-reference/profile.md index e54ffabe15..1b10025814 100644 --- a/_api-reference/profile.md +++ b/_api-reference/profile.md @@ -18,7 +18,7 @@ The Profile API provides timing information about the execution of individual co The Profile API is a resource-consuming operation that adds overhead to search operations. {: .warning} -## Path and HTTP methods +## Endpoints ```json GET /testindex/_search diff --git a/_api-reference/rank-eval.md b/_api-reference/rank-eval.md index 61c80be592..644b09929b 100644 --- a/_api-reference/rank-eval.md +++ b/_api-reference/rank-eval.md @@ -10,7 +10,7 @@ nav_order: 60 The [rank]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/rank/) eval endpoint allows you to evaluate the quality of ranked search results. -## Path and HTTP methods +## Endpoints ```json GET /_rank_eval diff --git a/_api-reference/remote-info.md b/_api-reference/remote-info.md index 25e032a9d5..f52e5259e9 100644 --- a/_api-reference/remote-info.md +++ b/_api-reference/remote-info.md @@ -15,7 +15,7 @@ This operation provides connection information for any remote OpenSearch cluster The response is more comprehensive and useful than a call to `_cluster/settings`, which only includes the cluster alias and seed nodes. -## Path and HTTP methods +## Endpoints ```json GET _remote/info diff --git a/_api-reference/script-apis/delete-script.md b/_api-reference/script-apis/delete-script.md index 22c2a3f394..acf0f10fcb 100644 --- a/_api-reference/script-apis/delete-script.md +++ b/_api-reference/script-apis/delete-script.md @@ -11,7 +11,7 @@ nav_order: 4 Deletes a stored script. -## Path and HTTP methods +## Endpoints ```json DELETE _scripts/my-script diff --git a/_api-reference/script-apis/exec-script.md b/_api-reference/script-apis/exec-script.md index cd31ad92f4..f91441be33 100644 --- a/_api-reference/script-apis/exec-script.md +++ b/_api-reference/script-apis/exec-script.md @@ -11,7 +11,7 @@ nav_order: 7 The Execute Painless script API allows you to run a script that is not stored. -## Path and HTTP methods +## Endpoints ```json GET /_scripts/painless/_execute diff --git a/_api-reference/script-apis/exec-stored-script.md b/_api-reference/script-apis/exec-stored-script.md index 31102c23dd..52db732ede 100644 --- a/_api-reference/script-apis/exec-stored-script.md +++ b/_api-reference/script-apis/exec-stored-script.md @@ -13,7 +13,7 @@ Runs a stored script written in the Painless language. OpenSearch provides several ways to run a script; the following sections show how to run a script by passing script information in the request body of a `GET /_search` request. -## Path and HTTP methods +## Endpoints ```json GET books/_search diff --git a/_api-reference/script-apis/get-stored-script.md b/_api-reference/script-apis/get-stored-script.md index 341bfc046e..5b1c3c75fd 100644 --- a/_api-reference/script-apis/get-stored-script.md +++ b/_api-reference/script-apis/get-stored-script.md @@ -11,7 +11,7 @@ nav_order: 3 Retrieves a stored script. -## Path and HTTP methods +## Endpoints ```json GET _scripts/my-first-script diff --git a/_api-reference/scroll.md b/_api-reference/scroll.md index 770697d4e4..1f2657fc18 100644 --- a/_api-reference/scroll.md +++ b/_api-reference/scroll.md @@ -17,7 +17,7 @@ To use the `scroll` operation, add a `scroll` parameter to the request header wi Because search contexts consume a lot of memory, we suggest you don't use the `scroll` operation for frequent user queries. Instead, use the `sort` parameter with the `search_after` parameter to scroll responses for user queries. {: .note } -## Path and HTTP methods +## Endpoints ```json GET _search/scroll diff --git a/_api-reference/search.md b/_api-reference/search.md index df6992912e..a9f5466052 100644 --- a/_api-reference/search.md +++ b/_api-reference/search.md @@ -12,7 +12,7 @@ redirect_from: The Search API operation lets you execute a search request to search your cluster for data. -## Path and HTTP Methods +## Endpoints ```json GET //_search diff --git a/_api-reference/snapshots/cleanup-snapshot-repository.md b/_api-reference/snapshots/cleanup-snapshot-repository.md index 18e8f35f81..202410c758 100644 --- a/_api-reference/snapshots/cleanup-snapshot-repository.md +++ b/_api-reference/snapshots/cleanup-snapshot-repository.md @@ -11,7 +11,7 @@ Introduced 1.0 The Cleanup Snapshot Repository API clears a snapshot repository of data no longer referenced by any existing snapshot. -## Path and HTTP methods +## Endpoints ```json POST /_snapshot//_cleanup diff --git a/_api-reference/snapshots/create-repository.md b/_api-reference/snapshots/create-repository.md index 40a35973e8..3567b56f88 100644 --- a/_api-reference/snapshots/create-repository.md +++ b/_api-reference/snapshots/create-repository.md @@ -19,7 +19,7 @@ There are two types of snapshot repositories: For instructions on creating a repository, see [Register repository]({{site.url}}{{site.baseurl}}/opensearch/snapshots/snapshot-restore#register-repository). -## Path and HTTP methods +## Endpoints ```json POST /_snapshot// diff --git a/_api-reference/snapshots/create-snapshot.md b/_api-reference/snapshots/create-snapshot.md index 45e5a28b55..ce96bd6442 100644 --- a/_api-reference/snapshots/create-snapshot.md +++ b/_api-reference/snapshots/create-snapshot.md @@ -15,7 +15,7 @@ Creates a snapshot within an existing repository. * To view a list of your repositories, see [Get snapshot repository]({{site.url}}{{site.baseurl}}/api-reference/snapshots/get-snapshot-repository). -## Path and HTTP methods +## Endpoints ```json PUT /_snapshot// diff --git a/_api-reference/snapshots/delete-snapshot-repository.md b/_api-reference/snapshots/delete-snapshot-repository.md index 2649c3c90d..14c2b6c86a 100644 --- a/_api-reference/snapshots/delete-snapshot-repository.md +++ b/_api-reference/snapshots/delete-snapshot-repository.md @@ -15,7 +15,7 @@ A repository in OpenSearch is simply a configuration that maps a repository name To learn more about repositories, see [Register or update snapshot repository]({{site.url}}{{site.baseurl}}/api-reference/snapshots/create-repository). -## Path and HTTP methods +## Endpoints ```json DELETE _snapshot/ diff --git a/_api-reference/snapshots/get-snapshot-repository.md b/_api-reference/snapshots/get-snapshot-repository.md index 1098cd544a..522ea0c659 100644 --- a/_api-reference/snapshots/get-snapshot-repository.md +++ b/_api-reference/snapshots/get-snapshot-repository.md @@ -16,7 +16,7 @@ To learn more about repositories, see [Register repository]({{site.url}}{{site.b You can also get details about a snapshot during and after snapshot creation. See [Get snapshot status]({{site.url}}{{site.baseurl}}/api-reference/snapshots/get-snapshot-status/). {: .note} -## Path and HTTP methods +## Endpoints ```json GET /_snapshot/ diff --git a/_api-reference/snapshots/get-snapshot-status.md b/_api-reference/snapshots/get-snapshot-status.md index 8675c23886..83043b7684 100644 --- a/_api-reference/snapshots/get-snapshot-status.md +++ b/_api-reference/snapshots/get-snapshot-status.md @@ -16,7 +16,7 @@ To learn about snapshot creation, see [Create snapshot]({{site.url}}{{site.baseu If you use the Security plugin, you must have the `monitor_snapshot`, `create_snapshot`, or `manage cluster` privileges. {: .note} -## Path and HTTP methods +## Endpoints ```json GET _snapshot///_status diff --git a/_api-reference/snapshots/get-snapshot.md b/_api-reference/snapshots/get-snapshot.md index 148f9e8ff2..c936cab602 100644 --- a/_api-reference/snapshots/get-snapshot.md +++ b/_api-reference/snapshots/get-snapshot.md @@ -11,7 +11,7 @@ nav_order: 6 Retrieves information about a snapshot. -## Path and HTTP methods +## Endpoints ```json GET _snapshot/// diff --git a/_api-reference/snapshots/restore-snapshot.md b/_api-reference/snapshots/restore-snapshot.md index b22c371134..a16b674141 100644 --- a/_api-reference/snapshots/restore-snapshot.md +++ b/_api-reference/snapshots/restore-snapshot.md @@ -19,7 +19,7 @@ Restores a snapshot of a cluster or specified data streams and indices. If open indexes with the same name that you want to restore already exist in the cluster, you must close, delete, or rename the indexes. See [Example request](#example-request) for information about renaming an index. See [Close index]({{site.url}}{{site.baseurl}}/api-reference/index-apis/close-index) for information about closing an index. {: .note} -## Path and HTTP methods +## Endpoints ```json GET _snapshot/// diff --git a/_api-reference/snapshots/verify-snapshot-repository.md b/_api-reference/snapshots/verify-snapshot-repository.md index 67a006e709..8827fee0c3 100644 --- a/_api-reference/snapshots/verify-snapshot-repository.md +++ b/_api-reference/snapshots/verify-snapshot-repository.md @@ -17,7 +17,7 @@ If verification is successful, the verify snapshot repository API returns a list If you use the Security plugin, you must have the `manage cluster` privilege. {: .note} -## Path and HTTP methods +## Endpoints ```json GET _snapshot// diff --git a/_api-reference/tasks.md b/_api-reference/tasks.md index 477e720d22..ef6a2bc30d 100644 --- a/_api-reference/tasks.md +++ b/_api-reference/tasks.md @@ -12,7 +12,7 @@ redirect_from: A task is any operation you run in a cluster. For example, searching your data collection of books for a title or author name is a task. When you run OpenSearch, a task is automatically created to monitor your cluster's health and performance. For more information about all of the tasks currently executing in your cluster, you can use the `tasks` API operation. -## Path and HTTP methods +## Endpoints ```json GET _tasks diff --git a/_api-reference/validate.md b/_api-reference/validate.md index 6e1470a505..4d1dc89a68 100644 --- a/_api-reference/validate.md +++ b/_api-reference/validate.md @@ -8,7 +8,7 @@ nav_order: 87 You can use the Validate Query API to validate a query without running it. The query can be sent as a path parameter or included in the request body. -## Path and HTTP methods +## Endpoints The Validate Query API contains the following path: diff --git a/_automating-configurations/api/create-workflow.md b/_automating-configurations/api/create-workflow.md index ad9552c3ef..3feb4672ea 100644 --- a/_automating-configurations/api/create-workflow.md +++ b/_automating-configurations/api/create-workflow.md @@ -25,7 +25,7 @@ The `POST` method creates a new workflow. The `PUT` method updates an existing w You can only update a complete workflow if it has not yet been provisioned. {: .note} -## Path and HTTP methods +## Endpoints ```json POST /_plugins/_flow_framework/workflow diff --git a/_automating-configurations/api/delete-workflow.md b/_automating-configurations/api/delete-workflow.md index 13cd5ae5dc..9869aba27a 100644 --- a/_automating-configurations/api/delete-workflow.md +++ b/_automating-configurations/api/delete-workflow.md @@ -13,7 +13,7 @@ Note that deleting a workflow only deletes the stored template---it does not dep When a workflow is deleted, its corresponding status (returned by the [Workflow State API]({{site.url}}{{site.baseurl}}/automating-configurations/api/get-workflow-status/)) is also deleted unless either the provisioning status is `IN_PROGRESS` or resources have been provisioned. -## Path and HTTP methods +## Endpoints ```json DELETE /_plugins/_flow_framework/workflow/ diff --git a/_automating-configurations/api/deprovision-workflow.md b/_automating-configurations/api/deprovision-workflow.md index 98c944a9d4..7cbb11ed2d 100644 --- a/_automating-configurations/api/deprovision-workflow.md +++ b/_automating-configurations/api/deprovision-workflow.md @@ -13,7 +13,7 @@ The workflow executes the provisioning steps in reverse order. If a failure occu To prevent data loss, resources created using the `create_index`, `create_search_pipeline`, and `create_ingest_pipeline` steps require the resource ID to be included in the `allow_delete` parameter. -## Path and HTTP methods +## Endpoints ```json POST /_plugins/_flow_framework/workflow//_deprovision diff --git a/_automating-configurations/api/get-workflow-status.md b/_automating-configurations/api/get-workflow-status.md index 280fb52195..e4f5c4f580 100644 --- a/_automating-configurations/api/get-workflow-status.md +++ b/_automating-configurations/api/get-workflow-status.md @@ -9,7 +9,7 @@ nav_order: 40 [Provisioning a workflow]({{site.url}}{{site.baseurl}}/automating-configurations/api/provision-workflow/) may take a significant amount of time, particularly when the action is associated with OpenSearch indexing operations. The Get Workflow State API permits monitoring of the provisioning deployment status until it is complete. -## Path and HTTP methods +## Endpoints ```json GET /_plugins/_flow_framework/workflow//_status diff --git a/_automating-configurations/api/get-workflow-steps.md b/_automating-configurations/api/get-workflow-steps.md index 38059ec80c..0c8606e092 100644 --- a/_automating-configurations/api/get-workflow-steps.md +++ b/_automating-configurations/api/get-workflow-steps.md @@ -27,7 +27,7 @@ This API returns a list of workflow steps, including their required inputs, outp } ``` -## Path and HTTP methods +## Endpoints ```json GET /_plugins/_flow_framework/workflow/_steps diff --git a/_automating-configurations/api/get-workflow.md b/_automating-configurations/api/get-workflow.md index 7b1d5987c4..0927e76203 100644 --- a/_automating-configurations/api/get-workflow.md +++ b/_automating-configurations/api/get-workflow.md @@ -9,7 +9,7 @@ nav_order: 20 The Get Workflow API retrieves the workflow template. -## Path and HTTP methods +## Endpoints ```json GET /_plugins/_flow_framework/workflow/ diff --git a/_automating-configurations/api/provision-workflow.md b/_automating-configurations/api/provision-workflow.md index cb1fe42789..c60b6f9892 100644 --- a/_automating-configurations/api/provision-workflow.md +++ b/_automating-configurations/api/provision-workflow.md @@ -14,7 +14,7 @@ The `workflows` template field may contain multiple workflows. The workflow with You can only provision a workflow if it has not yet been provisioned. Deprovision the workflow if you need to repeat provisioning. {: .note} -## Path and HTTP methods +## Endpoints ```json POST /_plugins/_flow_framework/workflow//_provision diff --git a/_automating-configurations/api/search-workflow-state.md b/_automating-configurations/api/search-workflow-state.md index 1cacb3a32b..786057c952 100644 --- a/_automating-configurations/api/search-workflow-state.md +++ b/_automating-configurations/api/search-workflow-state.md @@ -9,7 +9,7 @@ nav_order: 65 You can search for resources created by workflows by matching a query to a field. The fields you can search correspond to those returned by the [Get Workflow Status API]({{site.url}}{{site.baseurl}}/automating-configurations/api/get-workflow-status/). -## Path and HTTP methods +## Endpoints ```json GET /_plugins/_flow_framework/workflow/state/_search diff --git a/_automating-configurations/api/search-workflow.md b/_automating-configurations/api/search-workflow.md index b78de9e9d2..2882252d4e 100644 --- a/_automating-configurations/api/search-workflow.md +++ b/_automating-configurations/api/search-workflow.md @@ -9,7 +9,7 @@ nav_order: 60 You can retrieve created workflows with their `workflow_id` or search for workflows by using a query matching a field. You can use the `use_case` field to search for similar workflows. -## Path and HTTP methods +## Endpoints ```json GET /_plugins/_flow_framework/workflow/_search diff --git a/_im-plugin/ism/policies.md b/_im-plugin/ism/policies.md index 27c37e67ea..a049e68dff 100644 --- a/_im-plugin/ism/policies.md +++ b/_im-plugin/ism/policies.md @@ -457,7 +457,7 @@ Parameter | Description | Type | Required Rollup jobs can be continuous or non-continuous. A rollup job created using an ISM policy can only be non-continuous. {: .note } -#### Path and HTTP methods +#### Endpoints ````bash PUT _plugins/_rollup/jobs/ diff --git a/_ingest-pipelines/simulate-ingest.md b/_ingest-pipelines/simulate-ingest.md index 33ae935151..7e7d7b3750 100644 --- a/_ingest-pipelines/simulate-ingest.md +++ b/_ingest-pipelines/simulate-ingest.md @@ -13,7 +13,7 @@ redirect_from: Use the simulate ingest pipeline API operation to run or test the pipeline. -## Path and HTTP methods +## Endpoints The following requests **simulate the latest ingest pipeline created**: diff --git a/_ml-commons-plugin/api/agent-apis/delete-agent.md b/_ml-commons-plugin/api/agent-apis/delete-agent.md index ddde8fb19b..e9cd78fe25 100644 --- a/_ml-commons-plugin/api/agent-apis/delete-agent.md +++ b/_ml-commons-plugin/api/agent-apis/delete-agent.md @@ -12,7 +12,7 @@ nav_order: 50 You can use this API to delete an agent based on the `agent_id`. -## Path and HTTP methods +## Endpoints ```json DELETE /_plugins/_ml/agents/ diff --git a/_ml-commons-plugin/api/agent-apis/execute-agent.md b/_ml-commons-plugin/api/agent-apis/execute-agent.md index 2af4fc2c8e..6ab4933262 100644 --- a/_ml-commons-plugin/api/agent-apis/execute-agent.md +++ b/_ml-commons-plugin/api/agent-apis/execute-agent.md @@ -12,7 +12,7 @@ nav_order: 20 When an agent is executed, it runs the tools with which it is configured. -### Path and HTTP methods +### Endpoints ```json POST /_plugins/_ml/agents//_execute diff --git a/_ml-commons-plugin/api/agent-apis/get-agent.md b/_ml-commons-plugin/api/agent-apis/get-agent.md index 7a03e85221..dfc348cc8b 100644 --- a/_ml-commons-plugin/api/agent-apis/get-agent.md +++ b/_ml-commons-plugin/api/agent-apis/get-agent.md @@ -12,7 +12,7 @@ nav_order: 20 You can retrieve agent information using the `agent_id`. -## Path and HTTP methods +## Endpoints ```json GET /_plugins/_ml/agents/ diff --git a/_ml-commons-plugin/api/agent-apis/register-agent.md b/_ml-commons-plugin/api/agent-apis/register-agent.md index 0057b44427..1a81f89cd6 100644 --- a/_ml-commons-plugin/api/agent-apis/register-agent.md +++ b/_ml-commons-plugin/api/agent-apis/register-agent.md @@ -20,7 +20,7 @@ Agents may be of the following types: For more information about agents, see [Agents and tools]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/index/). -## Path and HTTP methods +## Endpoints ```json POST /_plugins/_ml/agents/_register diff --git a/_ml-commons-plugin/api/agent-apis/search-agent.md b/_ml-commons-plugin/api/agent-apis/search-agent.md index 63b1d07eed..0d08449eb5 100644 --- a/_ml-commons-plugin/api/agent-apis/search-agent.md +++ b/_ml-commons-plugin/api/agent-apis/search-agent.md @@ -12,7 +12,7 @@ nav_order: 30 Use this command to search for agents you've already created. You can provide any OpenSearch search query in the request body. -## Path and HTTP methods +## Endpoints ```json GET /_plugins/_ml/agents/_search diff --git a/_ml-commons-plugin/api/async-batch-ingest.md b/_ml-commons-plugin/api/async-batch-ingest.md index 493f192d0f..4f66fceb0a 100644 --- a/_ml-commons-plugin/api/async-batch-ingest.md +++ b/_ml-commons-plugin/api/async-batch-ingest.md @@ -13,7 +13,7 @@ nav_order: 35 Use the Asynchronous Batch Ingestion API to ingest data into your OpenSearch cluster from your files on remote file servers, such as Amazon Simple Storage Service (Amazon S3) or OpenAI. For detailed configuration steps, see [Asynchronous batch ingestion]({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/async-batch-ingestion/). -## Path and HTTP methods +## Endpoints ```json POST /_plugins/_ml/_batch_ingestion diff --git a/_ml-commons-plugin/api/connector-apis/create-connector.md b/_ml-commons-plugin/api/connector-apis/create-connector.md index b99306bb8a..bc0e05fda4 100644 --- a/_ml-commons-plugin/api/connector-apis/create-connector.md +++ b/_ml-commons-plugin/api/connector-apis/create-connector.md @@ -10,7 +10,7 @@ nav_order: 10 Creates a standalone connector. For more information, see [Connectors]({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/connectors/). -## Path and HTTP methods +## Endpoints ```json POST /_plugins/_ml/connectors/_create diff --git a/_ml-commons-plugin/api/connector-apis/delete-connector.md b/_ml-commons-plugin/api/connector-apis/delete-connector.md index 75dff32016..4969c42a20 100644 --- a/_ml-commons-plugin/api/connector-apis/delete-connector.md +++ b/_ml-commons-plugin/api/connector-apis/delete-connector.md @@ -10,7 +10,7 @@ nav_order: 30 Deletes a standalone connector. For more information, see [Connectors]({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/connectors/). -## Path and HTTP methods +## Endpoints ```json DELETE /_plugins/_ml/connectors/ diff --git a/_ml-commons-plugin/api/connector-apis/get-connector.md b/_ml-commons-plugin/api/connector-apis/get-connector.md index 6a8507cd32..583705b724 100644 --- a/_ml-commons-plugin/api/connector-apis/get-connector.md +++ b/_ml-commons-plugin/api/connector-apis/get-connector.md @@ -10,7 +10,7 @@ nav_order: 20 This API retrieves a connector by its ID. -### Path and HTTP methods +### Endpoints ```json GET /_plugins/_ml/connectors/ diff --git a/_ml-commons-plugin/api/connector-apis/search-connector.md b/_ml-commons-plugin/api/connector-apis/search-connector.md index 3b59d51a2e..35824ebf81 100644 --- a/_ml-commons-plugin/api/connector-apis/search-connector.md +++ b/_ml-commons-plugin/api/connector-apis/search-connector.md @@ -10,7 +10,7 @@ nav_order: 25 Use the `_search` endpoint to search for a connector. This API uses a query to search for matching connectors. -## Path and HTTP methods +## Endpoints ```json POST /_plugins/_ml/connectors/_search diff --git a/_ml-commons-plugin/api/connector-apis/update-connector.md b/_ml-commons-plugin/api/connector-apis/update-connector.md index 4b62652da8..6e90d94c9a 100644 --- a/_ml-commons-plugin/api/connector-apis/update-connector.md +++ b/_ml-commons-plugin/api/connector-apis/update-connector.md @@ -19,7 +19,7 @@ Using this API, you can update the connector fields listed in the [Request field For information about user access for this API, see [Model access control considerations]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/model-apis/index/#model-access-control-considerations). -## Path and HTTP methods +## Endpoints ```json PUT /_plugins/_ml/connectors/ diff --git a/_ml-commons-plugin/api/controller-apis/create-controller.md b/_ml-commons-plugin/api/controller-apis/create-controller.md index 9fe9306575..bd87d50d06 100644 --- a/_ml-commons-plugin/api/controller-apis/create-controller.md +++ b/_ml-commons-plugin/api/controller-apis/create-controller.md @@ -19,7 +19,7 @@ The POST method creates a new controller. The PUT method updates an existing con To learn how to set rate limits at the model level for all users, see [Update Model API]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/model-apis/update-model/). The rate limit is set to either the model-level limit or the user-level limit, whichever is more restrictive. For example, if the model-level limit is 2 requests per minute and the user-level limit is 4 requests per minute, the overall limit will be set to 2 requests per minute. -## Path and HTTP methods +## Endpoints ```json POST /_plugins/_ml/controllers/ diff --git a/_ml-commons-plugin/api/controller-apis/delete-controller.md b/_ml-commons-plugin/api/controller-apis/delete-controller.md index 44120198fa..3c7aa1397a 100644 --- a/_ml-commons-plugin/api/controller-apis/delete-controller.md +++ b/_ml-commons-plugin/api/controller-apis/delete-controller.md @@ -12,7 +12,7 @@ nav_order: 50 Use this API to delete a controller for a model based on the `model_id`. -## Path and HTTP methods +## Endpoints ```json DELETE /_plugins/_ml/controllers/ diff --git a/_ml-commons-plugin/api/controller-apis/get-controller.md b/_ml-commons-plugin/api/controller-apis/get-controller.md index 48e6f16549..b01ef96911 100644 --- a/_ml-commons-plugin/api/controller-apis/get-controller.md +++ b/_ml-commons-plugin/api/controller-apis/get-controller.md @@ -12,7 +12,7 @@ nav_order: 20 Use this API to retrieve information about a controller for a model by model ID. -### Path and HTTP methods +### Endpoints ```json GET /_plugins/_ml/controllers/ diff --git a/_ml-commons-plugin/api/execute-algorithm.md b/_ml-commons-plugin/api/execute-algorithm.md index 6acd926444..af08c31264 100644 --- a/_ml-commons-plugin/api/execute-algorithm.md +++ b/_ml-commons-plugin/api/execute-algorithm.md @@ -9,7 +9,7 @@ nav_order: 37 Some algorithms, such as [Localization]({{site.url}}{{site.baseurl}}/ml-commons-plugin/algorithms#localization), don't require trained models. You can run no-model-based algorithms using the `execute` API. -## Path and HTTP methods +## Endpoints ```json POST _plugins/_ml/_execute/ diff --git a/_ml-commons-plugin/api/memory-apis/create-memory.md b/_ml-commons-plugin/api/memory-apis/create-memory.md index 58ba34b2a4..67f2ff75bd 100644 --- a/_ml-commons-plugin/api/memory-apis/create-memory.md +++ b/_ml-commons-plugin/api/memory-apis/create-memory.md @@ -19,7 +19,7 @@ The POST method creates a new memory. The PUT method updates an existing memory. When the Security plugin is enabled, all memories exist in a `private` security mode. Only the user who created a memory can interact with that memory and its messages. {: .important} -## Path and HTTP methods +## Endpoints ```json POST /_plugins/_ml/memory/ diff --git a/_ml-commons-plugin/api/memory-apis/create-message.md b/_ml-commons-plugin/api/memory-apis/create-message.md index 78ec0ade34..561e321624 100644 --- a/_ml-commons-plugin/api/memory-apis/create-message.md +++ b/_ml-commons-plugin/api/memory-apis/create-message.md @@ -22,7 +22,7 @@ You can only update the `additional_info` field of a message. When the Security plugin is enabled, all memories exist in a `private` security mode. Only the user who created a memory can interact with that memory and its messages. {: .important} -## Path and HTTP methods +## Endpoints ```json POST /_plugins/_ml/memory//messages diff --git a/_ml-commons-plugin/api/memory-apis/delete-memory.md b/_ml-commons-plugin/api/memory-apis/delete-memory.md index 99e4cdb574..46bbf3ac4a 100644 --- a/_ml-commons-plugin/api/memory-apis/delete-memory.md +++ b/_ml-commons-plugin/api/memory-apis/delete-memory.md @@ -15,7 +15,7 @@ Use this API to delete a memory based on the `memory_id`. When the Security plugin is enabled, all memories exist in a `private` security mode. Only the user who created a memory can interact with that memory and its messages. {: .important} -## Path and HTTP methods +## Endpoints ```json DELETE /_plugins/_ml/memory/ diff --git a/_ml-commons-plugin/api/memory-apis/get-memory.md b/_ml-commons-plugin/api/memory-apis/get-memory.md index 7f62445072..90a60453d2 100644 --- a/_ml-commons-plugin/api/memory-apis/get-memory.md +++ b/_ml-commons-plugin/api/memory-apis/get-memory.md @@ -29,7 +29,7 @@ When the Security plugin is enabled, all memories exist in a `private` security You can retrieve memory information by using the `memory_id`. The response includes all messages within the memory. -### Path and HTTP methods +### Endpoints ```json GET /_plugins/_ml/memory/ @@ -65,7 +65,7 @@ GET /_plugins/_ml/memory/N8AE1osB0jLkkocYjz7D Use this command to get all memories. -### Path and HTTP methods +### Endpoints ```json GET /_plugins/_ml/memory diff --git a/_ml-commons-plugin/api/memory-apis/get-message-traces.md b/_ml-commons-plugin/api/memory-apis/get-message-traces.md index 1b0e9b1902..fb00a7e82a 100644 --- a/_ml-commons-plugin/api/memory-apis/get-message-traces.md +++ b/_ml-commons-plugin/api/memory-apis/get-message-traces.md @@ -18,7 +18,7 @@ When the Security plugin is enabled, all memories exist in a `private` security {: .important} -## Path and HTTP methods +## Endpoints ```json GET /_plugins/_ml/memory/message//traces diff --git a/_ml-commons-plugin/api/memory-apis/get-message.md b/_ml-commons-plugin/api/memory-apis/get-message.md index 36baa84bf4..8807146e20 100644 --- a/_ml-commons-plugin/api/memory-apis/get-message.md +++ b/_ml-commons-plugin/api/memory-apis/get-message.md @@ -24,7 +24,7 @@ When the Security plugin is enabled, all memories exist in a `private` security You can retrieve message information by using the `message_id`. -### Path and HTTP methods +### Endpoints ```json GET /_plugins/_ml/memory/message/ @@ -68,7 +68,7 @@ For information about response fields, see [Create Message request fields]({{sit Use this command to get a list of messages for a certain memory. -### Path and HTTP methods +### Endpoints ```json GET /_plugins/_ml/memory//messages diff --git a/_ml-commons-plugin/api/memory-apis/search-memory.md b/_ml-commons-plugin/api/memory-apis/search-memory.md index 4fa022bfaf..20e716a210 100644 --- a/_ml-commons-plugin/api/memory-apis/search-memory.md +++ b/_ml-commons-plugin/api/memory-apis/search-memory.md @@ -15,7 +15,7 @@ This API retrieves a conversational memory for [conversational search]({{site.ur When the Security plugin is enabled, all memories exist in a `private` security mode. Only the user who created a memory can interact with that memory and its messages. {: .important} -## Path and HTTP methods +## Endpoints ```json GET /_plugins/_ml/memory/_search diff --git a/_ml-commons-plugin/api/memory-apis/search-message.md b/_ml-commons-plugin/api/memory-apis/search-message.md index 22602c21f2..3242ffae4b 100644 --- a/_ml-commons-plugin/api/memory-apis/search-message.md +++ b/_ml-commons-plugin/api/memory-apis/search-message.md @@ -15,7 +15,7 @@ Retrieves message information for [conversational search]({{site.url}}{{site.bas When the Security plugin is enabled, all memories exist in a `private` security mode. Only the user who created a memory can interact with that memory and its messages. {: .important} -## Path and HTTP methods +## Endpoints ```json POST /_plugins/_ml/memory//_search diff --git a/_ml-commons-plugin/api/model-apis/batch-predict.md b/_ml-commons-plugin/api/model-apis/batch-predict.md index c1dc7348fe..43fd95cc04 100644 --- a/_ml-commons-plugin/api/model-apis/batch-predict.md +++ b/_ml-commons-plugin/api/model-apis/batch-predict.md @@ -23,7 +23,7 @@ For instructions on how set up batch inference and connector blueprints, see the - [OpenAI batch predict connector blueprint](https://github.com/opensearch-project/ml-commons/blob/main/docs/remote_inference_blueprints/batch_inference_openAI_connector_blueprint.md) -## Path and HTTP methods +## Endpoints ```json POST /_plugins/_ml/models//_batch_predict diff --git a/_ml-commons-plugin/api/model-apis/delete-model.md b/_ml-commons-plugin/api/model-apis/delete-model.md index b35e7c808b..009e4d9436 100644 --- a/_ml-commons-plugin/api/model-apis/delete-model.md +++ b/_ml-commons-plugin/api/model-apis/delete-model.md @@ -15,7 +15,7 @@ When you delete the last model version in a model group, that model group is aut For information about user access for this API, see [Model access control considerations]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/model-apis/index/#model-access-control-considerations). -## Path and HTTP methods +## Endpoints ```json DELETE /_plugins/_ml/models/ diff --git a/_ml-commons-plugin/api/model-apis/deploy-model.md b/_ml-commons-plugin/api/model-apis/deploy-model.md index 2c6991ba22..536ea68864 100644 --- a/_ml-commons-plugin/api/model-apis/deploy-model.md +++ b/_ml-commons-plugin/api/model-apis/deploy-model.md @@ -24,7 +24,7 @@ PUT _cluster/settings For information about user access for this API, see [Model access control considerations]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/model-apis/index/#model-access-control-considerations). -## Path and HTTP methods +## Endpoints ```json POST /_plugins/_ml/models//_deploy diff --git a/_ml-commons-plugin/api/model-apis/get-model.md b/_ml-commons-plugin/api/model-apis/get-model.md index 0286497d31..4017f820a5 100644 --- a/_ml-commons-plugin/api/model-apis/get-model.md +++ b/_ml-commons-plugin/api/model-apis/get-model.md @@ -12,7 +12,7 @@ You can retrieve model information using the `model_id`. For information about user access for this API, see [Model access control considerations]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/model-apis/index/#model-access-control-considerations). -## Path and HTTP methods +## Endpoints ```json GET /_plugins/_ml/models/ diff --git a/_ml-commons-plugin/api/model-apis/register-model.md b/_ml-commons-plugin/api/model-apis/register-model.md index 63537d0443..df05add2f1 100644 --- a/_ml-commons-plugin/api/model-apis/register-model.md +++ b/_ml-commons-plugin/api/model-apis/register-model.md @@ -24,7 +24,7 @@ For information about user access for this API, see [Model access control consid If the model is more than 10 MB in size, ML Commons splits it into smaller chunks and saves those chunks in the model's index. -## Path and HTTP methods +## Endpoints ```json POST /_plugins/_ml/models/_register diff --git a/_ml-commons-plugin/api/model-apis/search-model.md b/_ml-commons-plugin/api/model-apis/search-model.md index 729237eb74..a203d69baa 100644 --- a/_ml-commons-plugin/api/model-apis/search-model.md +++ b/_ml-commons-plugin/api/model-apis/search-model.md @@ -18,7 +18,7 @@ The response will contain only those model versions to which you have access. Fo For information about user access for this API, see [Model access control considerations]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/model-apis/index/#model-access-control-considerations). -## Path and HTTP methods +## Endpoints ```json GET /_plugins/_ml/models/_search diff --git a/_ml-commons-plugin/api/model-apis/undeploy-model.md b/_ml-commons-plugin/api/model-apis/undeploy-model.md index 4e9360f0b5..99d088e587 100644 --- a/_ml-commons-plugin/api/model-apis/undeploy-model.md +++ b/_ml-commons-plugin/api/model-apis/undeploy-model.md @@ -12,7 +12,7 @@ To undeploy a model from memory, use the undeploy operation. For information about user access for this API, see [Model access control considerations]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/model-apis/index/#model-access-control-considerations). -### Path and HTTP methods +### Endpoints ```json POST /_plugins/_ml/models//_undeploy diff --git a/_ml-commons-plugin/api/model-apis/update-model.md b/_ml-commons-plugin/api/model-apis/update-model.md index 083f2cb448..3e9e92b4a7 100644 --- a/_ml-commons-plugin/api/model-apis/update-model.md +++ b/_ml-commons-plugin/api/model-apis/update-model.md @@ -14,7 +14,7 @@ Updates a model based on the `model_ID`. For information about user access for this API, see [Model access control considerations]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/model-apis/index/#model-access-control-considerations). -## Path and HTTP methods +## Endpoints ```json PUT /_plugins/_ml/models/ diff --git a/_ml-commons-plugin/api/profile.md b/_ml-commons-plugin/api/profile.md index 8337f23e6e..d7679a57ec 100644 --- a/_ml-commons-plugin/api/profile.md +++ b/_ml-commons-plugin/api/profile.md @@ -24,7 +24,7 @@ PUT _cluster/settings To clear all monitoring requests, set `plugins.ml_commons.monitoring_request_count` to `0`. -## Path and HTTP methods +## Endpoints ```json GET /_plugins/_ml/profile diff --git a/_ml-commons-plugin/api/stats.md b/_ml-commons-plugin/api/stats.md index 8d93a96d98..3cf608dc4f 100644 --- a/_ml-commons-plugin/api/stats.md +++ b/_ml-commons-plugin/api/stats.md @@ -9,7 +9,7 @@ nav_order: 50 Gets statistics related to the number of tasks. -## Path and HTTP methods +## Endpoints ```json GET /_plugins/_ml/stats diff --git a/_ml-commons-plugin/api/tasks-apis/delete-task.md b/_ml-commons-plugin/api/tasks-apis/delete-task.md index f3e0b0896f..5db3bfb7dc 100644 --- a/_ml-commons-plugin/api/tasks-apis/delete-task.md +++ b/_ml-commons-plugin/api/tasks-apis/delete-task.md @@ -13,7 +13,7 @@ Deletes a task based on the `task_id`. ML Commons does not check the task status when running the delete request. There is a risk that a currently running task could be deleted before the task completes. To check the status of a task, run `GET /_plugins/_ml/tasks/` before task deletion. {: .note} -### Path and HTTP methods +### Endpoints ```json DELETE /_plugins/_ml/tasks/ diff --git a/_ml-commons-plugin/api/tasks-apis/get-task.md b/_ml-commons-plugin/api/tasks-apis/get-task.md index 14b28e8457..c27b16c1a5 100644 --- a/_ml-commons-plugin/api/tasks-apis/get-task.md +++ b/_ml-commons-plugin/api/tasks-apis/get-task.md @@ -10,7 +10,7 @@ nav_order: 10 You can retrieve information about a task using the `task_id`. -## Path and HTTP methods +## Endpoints ```json GET /_plugins/_ml/tasks/ diff --git a/_ml-commons-plugin/api/tasks-apis/search-task.md b/_ml-commons-plugin/api/tasks-apis/search-task.md index 526684a9ef..026249c9a6 100644 --- a/_ml-commons-plugin/api/tasks-apis/search-task.md +++ b/_ml-commons-plugin/api/tasks-apis/search-task.md @@ -10,7 +10,7 @@ nav_order: 15 Searches tasks based on parameters indicated in the request body. -## Path and HTTP methods +## Endpoints ```json GET /_plugins/_ml/tasks/_search diff --git a/_ml-commons-plugin/api/train-predict/predict.md b/_ml-commons-plugin/api/train-predict/predict.md index ea0938da36..a3f369992e 100644 --- a/_ml-commons-plugin/api/train-predict/predict.md +++ b/_ml-commons-plugin/api/train-predict/predict.md @@ -12,7 +12,7 @@ ML Commons can predict new data with your trained model either from indexed data For information about user access for this API, see [Model access control considerations]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/model-apis/index/#model-access-control-considerations). -## Path and HTTP methods +## Endpoints ```json POST /_plugins/_ml/_predict// diff --git a/_observing-your-data/query-insights/health.md b/_observing-your-data/query-insights/health.md index 02324d8237..52c6832f45 100644 --- a/_observing-your-data/query-insights/health.md +++ b/_observing-your-data/query-insights/health.md @@ -15,7 +15,7 @@ The Query Insights plugin provides an [API](#health-stats-api) and [metrics](#op The Health Stats API provides health metrics for each node running the Query Insights plugin. These metrics allow for an in-depth view of resource usage and the health of the query processing components. -### Path and HTTP methods +### Endpoints ```json GET _insights/health_stats diff --git a/_search-plugins/querqy/index.md b/_search-plugins/querqy/index.md index 4ec0c8eb1a..dc2d53065e 100644 --- a/_search-plugins/querqy/index.md +++ b/_search-plugins/querqy/index.md @@ -28,7 +28,7 @@ Answer `yes` to the security prompts during the installation as Querqy requires After installing the Querqy plugin you can find comprehensive documentation on the Querqy.org site: [Querqy](https://docs.querqy.org/querqy/index.html) -## Path and HTTP methods +## Endpoints ``` POST /myindex/_search diff --git a/_search-plugins/searching-data/point-in-time-api.md b/_search-plugins/searching-data/point-in-time-api.md index 6a3d867052..202733145a 100644 --- a/_search-plugins/searching-data/point-in-time-api.md +++ b/_search-plugins/searching-data/point-in-time-api.md @@ -28,7 +28,7 @@ Introduced 2.4 Creates a PIT. The `keep_alive` query parameter is required; it specifies how long to keep a PIT. -### Path and HTTP methods +### Endpoints ```json POST //_search/point_in_time?keep_alive=1h&routing=&expand_wildcards=&preference= diff --git a/_security-analytics/api-tools/detector-api.md b/_security-analytics/api-tools/detector-api.md index 5b0f9a9eb0..a0f0f683e5 100644 --- a/_security-analytics/api-tools/detector-api.md +++ b/_security-analytics/api-tools/detector-api.md @@ -345,7 +345,7 @@ Field | Type | Description This API uses the detector ID to specify and delete a detector. -### Path and HTTP methods +### Endpoints ```json DELETE /_plugins/_security_analytics/detectors/IJAXz4QBrmVplM4JYxx_ @@ -372,7 +372,7 @@ DELETE /_plugins/_security_analytics/detectors/ The Get Detector API retrieves the detector details. Use the detector ID in the call to fetch detector details. -### Path and HTTP methods +### Endpoints ```json GET /_plugins/_security_analytics/detectors/x-dwFIYBT6_n8WeuQjo4 diff --git a/_security-analytics/threat-intelligence/api/findings.md b/_security-analytics/threat-intelligence/api/findings.md index 5c648ab2ae..23474e4e40 100644 --- a/_security-analytics/threat-intelligence/api/findings.md +++ b/_security-analytics/threat-intelligence/api/findings.md @@ -18,7 +18,7 @@ The threat intelligence Alerts and Findings API retrieves information about aler Retrieves any alerts related to threat intelligence monitors. -### Path and HTTP methods +### Endpoints ```json GET /_plugins/_security_analytics/threat_intel/alerts @@ -94,7 +94,7 @@ A threat intelligence alert can have one of the following states. Updates the status of the specified alerts to `ACKNOWLEDGED` or `COMPLETED`. Only alerts in the `ACTIVE` state can be updated. -### Path and HTTP methods +### Endpoints ```json PUT /plugins/security_analytics/threat_intel/alerts/status @@ -174,7 +174,7 @@ PUT /plugins/security_analytics/threat_intel/alerts/status?state=COMPLETED&alert Returns threat intelligence indicator of compromise (IOC) findings. When the threat intelligence monitor finds a malicious IOC during a data scan, a finding is automatically generated. -### Path and HTTP methods +### Endpoints ```json GET /_plugins/_security_analytics/threat_intel/findings/ diff --git a/_security-analytics/threat-intelligence/api/monitor.md b/_security-analytics/threat-intelligence/api/monitor.md index e22b31f156..9a3ba76836 100644 --- a/_security-analytics/threat-intelligence/api/monitor.md +++ b/_security-analytics/threat-intelligence/api/monitor.md @@ -16,7 +16,7 @@ You can use the threat intelligence Monitor API to create, search, and update [m Creates or updates a threat intelligence monitor. -### Path and HTTP methods +### Endpoints The `POST` method creates a new monitor. The `PUT` method updates a monitor. @@ -207,7 +207,7 @@ The following section provides example requests for the Monitor API. Deletes an existing threat intelligence monitor. -### Path and HTTP methods +### Endpoints ```json DELETE /_plugins/_security_analytics/threat_intel/monitors/ diff --git a/_security-analytics/threat-intelligence/api/source.md b/_security-analytics/threat-intelligence/api/source.md index e9bd540477..efa71fd968 100644 --- a/_security-analytics/threat-intelligence/api/source.md +++ b/_security-analytics/threat-intelligence/api/source.md @@ -14,7 +14,7 @@ The threat intelligence Source API updates and returns information about tasks r Creates or updates a threat intelligence source and loads indicators of compromise (IOCs) from that source. -### Path and HTTP methods +### Endpoints ```json POST _plugins/_security_analytics/threat_intel/sources @@ -283,7 +283,7 @@ The following example responses show what OpenSearch returns after a successful Retrieves the threat intelligence source configuration details. -### Path and HTTP methods +### Endpoints ```json @@ -346,7 +346,7 @@ GET /_plugins/_security_analytics/threat_intel/sources/ Searches for threat intelligence source matches based on the search query. The request body expects a search query. For query options, see [Query DSL]({{site.url}}{{site.baseurl}}/query-dsl/). -### Path and HTTP methods +### Endpoints ```json POST /_plugins/_security_analytics/threat_intel/sources/_search @@ -440,7 +440,7 @@ POST /_plugins/_security_analytics/threat_intel/sources/_search Deletes a threat intelligence source. -### Path and HTTP methods +### Endpoints ```json DELETE /_plugins/_security_analytics/threat_intel/sources/ @@ -466,7 +466,7 @@ DELETE /_plugins/_security_analytics/threat_intel/sources/2c0u7JAB9IJUg27gcjUp Downloads any IOCs from the threat intelligence source. Only supports the `S3_CUSTOM` type source. -### Path and HTTP methods +### Endpoints ```json POST /_plugins/_security_analytics/threat_intel/sources//_refresh diff --git a/_security/access-control/api.md b/_security/access-control/api.md index 0a6aedbb95..abb89380cb 100644 --- a/_security/access-control/api.md +++ b/_security/access-control/api.md @@ -171,7 +171,7 @@ Introduced 1.0 Changes the password for the current user. -#### Path and HTTP methods +#### Endpoints ```json PUT _plugins/_security/api/account @@ -1568,7 +1568,7 @@ PUT _plugins/_security/api/nodesdn/ Makes a bulk update for the list of distinguished names. -#### Path and HTTP methods +#### Endpoints ```json PATCH _plugins/_security/api/nodesdn @@ -1682,7 +1682,7 @@ GET _plugins/_security/api/ssl/certs Reload transport layer communication certificates. These REST APIs let a super admin (or a user with sufficient permissions to access this API) reload transport layer certificates. -#### Path and HTTP methods +#### Endpoints ```json PUT /_plugins/_security/api/ssl/transport/reloadcerts @@ -1717,7 +1717,7 @@ curl -X PUT "https://your-opensearch-cluster/_plugins/_security/api/ssl/transpor Reload HTTP layer communication certificates. These REST APIs let a super admin (or a user with sufficient permissions to access this API) reload HTTP layer certificates. -#### Path and HTTP methods +#### Endpoints ```json PUT /_plugins/_security/api/ssl/http/reloadcerts diff --git a/_tuning-your-cluster/availability-and-recovery/remote-store/remote-store-stats-api.md b/_tuning-your-cluster/availability-and-recovery/remote-store/remote-store-stats-api.md index b184930e1d..6139ef041d 100644 --- a/_tuning-your-cluster/availability-and-recovery/remote-store/remote-store-stats-api.md +++ b/_tuning-your-cluster/availability-and-recovery/remote-store/remote-store-stats-api.md @@ -15,7 +15,7 @@ Use the Remote Store Stats API to monitor shard-level remote-backed storage perf Metrics returned from this API only relate to indexes stored on remote-backed nodes. For an aggregated output on an index at the node or cluster level, use the [Index Stats]({{site.url}}{{site.baseurl}}/api-reference/index-apis/stats/), [Nodes Stats]({{site.url}}{{site.baseurl}}/api-reference/nodes-apis/nodes-stats/), or [Cluster Stats]({{site.url}}{{site.baseurl}}/api-reference/cluster-api/cluster-stats/) API. -## Path and HTTP methods +## Endpoints ```json GET _remotestore/stats/ diff --git a/_tuning-your-cluster/availability-and-recovery/segment-replication/backpressure.md b/_tuning-your-cluster/availability-and-recovery/segment-replication/backpressure.md index 498aae55fc..b942de7b94 100644 --- a/_tuning-your-cluster/availability-and-recovery/segment-replication/backpressure.md +++ b/_tuning-your-cluster/availability-and-recovery/segment-replication/backpressure.md @@ -24,7 +24,7 @@ Field | Data type | Description `segrep.pressure.checkpoint.limit` | Integer | The maximum number of indexing checkpoints that a replica shard can fall behind when copying from primary. Once `segrep.pressure.checkpoint.limit` is breached along with `segrep.pressure.time.limit`, the segment replication backpressure mechanism is initiated. Default is `4` checkpoints. `segrep.pressure.replica.stale.limit `| Floating point | The maximum number of stale replica shards that can exist in a replication group. Once `segrep.pressure.replica.stale.limit` is breached, the segment replication backpressure mechanism is initiated. Default is `.5`, which is 50% of a replication group. -## Path and HTTP methods +## Endpoints You can use the segment replication API endpoint to retrieve segment replication backpressure metrics as follows: diff --git a/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md b/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md index b494ee1699..5f8ce4109b 100644 --- a/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md +++ b/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md @@ -10,7 +10,7 @@ grand_parent: Availability and recovery The Query Group Lifecycle API creates, updates, retrieves, and deletes query groups. The API categorizes queries into specific groups, called _query groups_, based on desired resource limits. -## Path and HTTP methods +## Endpoints ### Create a query group diff --git a/templates/API_TEMPLATE.md b/templates/API_TEMPLATE.md index 02c0f341d9..654b3c7a6b 100644 --- a/templates/API_TEMPLATE.md +++ b/templates/API_TEMPLATE.md @@ -11,7 +11,7 @@ Introduced 1.0 The Example API ... (descriptive sentence about what this API does). -## Path and HTTP methods +## Endpoints ```json POST /_example/endpoint/