diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 7d5dc3a2ad..08a7b3e82c 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -28455,7 +28455,7 @@ "summary": "Search a vector tile", "description": "Search a vector tile for geospatial values.\nBefore using this API, you should be familiar with the Mapbox vector tile specification.\nThe API returns results as a binary mapbox vector tile.\n\nInternally, Elasticsearch translates a vector tile search API request into a search containing:\n\n* A `geo_bounding_box` query on the ``. The query uses the `//` tile as a bounding box.\n* A `geotile_grid` or `geohex_grid` aggregation on the ``. The `grid_agg` parameter determines the aggregation type. The aggregation uses the `//` tile as a bounding box.\n* Optionally, a `geo_bounds` aggregation on the ``. The search only includes this aggregation if the `exact_bounds` parameter is `true`.\n* If the optional parameter `with_labels` is `true`, the internal search will include a dynamic runtime field that calls the `getLabelPosition` function of the geometry doc value. This enables the generation of new point features containing suggested geometry labels, so that, for example, multi-polygons will have only one label.\n\nFor example, Elasticsearch may translate a vector tile search API request with a `grid_agg` argument of `geotile` and an `exact_bounds` argument of `true` into the following search\n\n```\nGET my-index/_search\n{\n \"size\": 10000,\n \"query\": {\n \"geo_bounding_box\": {\n \"my-geo-field\": {\n \"top_left\": {\n \"lat\": -40.979898069620134,\n \"lon\": -45\n },\n \"bottom_right\": {\n \"lat\": -66.51326044311186,\n \"lon\": 0\n }\n }\n }\n },\n \"aggregations\": {\n \"grid\": {\n \"geotile_grid\": {\n \"field\": \"my-geo-field\",\n \"precision\": 11,\n \"size\": 65536,\n \"bounds\": {\n \"top_left\": {\n \"lat\": -40.979898069620134,\n \"lon\": -45\n },\n \"bottom_right\": {\n \"lat\": -66.51326044311186,\n \"lon\": 0\n }\n }\n }\n },\n \"bounds\": {\n \"geo_bounds\": {\n \"field\": \"my-geo-field\",\n \"wrap_longitude\": false\n }\n }\n }\n}\n```\n\nThe API returns results as a binary Mapbox vector tile.\nMapbox vector tiles are encoded as Google Protobufs (PBF). By default, the tile contains three layers:\n\n* A `hits` layer containing a feature for each `` value matching the `geo_bounding_box` query.\n* An `aggs` layer containing a feature for each cell of the `geotile_grid` or `geohex_grid`. The layer only contains features for cells with matching data.\n* A meta layer containing:\n * A feature containing a bounding box. By default, this is the bounding box of the tile.\n * Value ranges for any sub-aggregations on the `geotile_grid` or `geohex_grid`.\n * Metadata for the search.\n\nThe API only returns features that can display at its zoom level.\nFor example, if a polygon feature has no area at its zoom level, the API omits it.\nThe API returns errors as UTF-8 encoded JSON.\n\nIMPORTANT: You can specify several options for this API as either a query parameter or request body parameter.\nIf you specify both parameters, the query parameter takes precedence.\n\n**Grid precision for geotile**\n\nFor a `grid_agg` of `geotile`, you can use cells in the `aggs` layer as tiles for lower zoom levels.\n`grid_precision` represents the additional zoom levels available through these cells. The final precision is computed by as follows: ` + grid_precision`.\nFor example, if `` is 7 and `grid_precision` is 8, then the `geotile_grid` aggregation will use a precision of 15.\nThe maximum final precision is 29.\nThe `grid_precision` also determines the number of cells for the grid as follows: `(2^grid_precision) x (2^grid_precision)`.\nFor example, a value of 8 divides the tile into a grid of 256 x 256 cells.\nThe `aggs` layer only contains features for cells with matching data.\n\n**Grid precision for geohex**\n\nFor a `grid_agg` of `geohex`, Elasticsearch uses `` and `grid_precision` to calculate a final precision as follows: ` + grid_precision`.\n\nThis precision determines the H3 resolution of the hexagonal cells produced by the `geohex` aggregation.\nThe following table maps the H3 resolution for each precision.\nFor example, if `` is 3 and `grid_precision` is 3, the precision is 6.\nAt a precision of 6, hexagonal cells have an H3 resolution of 2.\nIf `` is 3 and `grid_precision` is 4, the precision is 7.\nAt a precision of 7, hexagonal cells have an H3 resolution of 3.\n\n| Precision | Unique tile bins | H3 resolution | Unique hex bins |\tRatio |\n| --------- | ---------------- | ------------- | ----------------| ----- |\n| 1 | 4 | 0 | 122 | 30.5 |\n| 2 | 16 | 0 | 122 | 7.625 |\n| 3 | 64 | 1 | 842 | 13.15625 |\n| 4 | 256 | 1 | 842 | 3.2890625 |\n| 5 | 1024 | 2 | 5882 | 5.744140625 |\n| 6 | 4096 | 2 | 5882 | 1.436035156 |\n| 7 | 16384 | 3 | 41162 | 2.512329102 |\n| 8 | 65536 | 3 | 41162 | 0.6280822754 |\n| 9 | 262144 | 4 | 288122 | 1.099098206 |\n| 10 | 1048576 | 4 | 288122 | 0.2747745514 |\n| 11 | 4194304 | 5 | 2016842 | 0.4808526039 |\n| 12 | 16777216 | 6 | 14117882 | 0.8414913416 |\n| 13 | 67108864 | 6 | 14117882 | 0.2103728354 |\n| 14 | 268435456 | 7 | 98825162 | 0.3681524172 |\n| 15 | 1073741824 | 8 | 691776122 | 0.644266719 |\n| 16 | 4294967296 | 8 | 691776122 | 0.1610666797 |\n| 17 | 17179869184 | 9 | 4842432842 | 0.2818666889 |\n| 18 | 68719476736 | 10 | 33897029882 | 0.4932667053 |\n| 19 | 274877906944 | 11 | 237279209162 | 0.8632167343 |\n| 20 | 1099511627776 | 11 | 237279209162 | 0.2158041836 |\n| 21 | 4398046511104 | 12 | 1660954464122 | 0.3776573213 |\n| 22 | 17592186044416 | 13 | 11626681248842 | 0.6609003122 |\n| 23 | 70368744177664 | 13 | 11626681248842 | 0.165225078 |\n| 24 | 281474976710656 | 14 | 81386768741882 | 0.2891438866 |\n| 25 | 1125899906842620 | 15 | 569707381193162 | 0.5060018015 |\n| 26 | 4503599627370500 | 15 | 569707381193162 | 0.1265004504 |\n| 27 | 18014398509482000 | 15 | 569707381193162 | 0.03162511259 |\n| 28 | 72057594037927900 | 15 | 569707381193162 | 0.007906278149 |\n| 29 | 288230376151712000 | 15 | 569707381193162 | 0.001976569537 |\n\nHexagonal cells don't align perfectly on a vector tile.\nSome cells may intersect more than one vector tile.\nTo compute the H3 resolution for each precision, Elasticsearch compares the average density of hexagonal bins at each resolution with the average density of tile bins at each zoom level.\nElasticsearch uses the H3 resolution that is closest to the corresponding geotile density.", "externalDocs": { - "url": "https://github.com/mapbox/vector-tile-spec/blob/master/README.md" + "url": "https://github.com/mapbox/vector-tile-spec/blob/current/README.md" }, "operationId": "search-mvt-1", "parameters": [ @@ -28513,7 +28513,7 @@ "summary": "Search a vector tile", "description": "Search a vector tile for geospatial values.\nBefore using this API, you should be familiar with the Mapbox vector tile specification.\nThe API returns results as a binary mapbox vector tile.\n\nInternally, Elasticsearch translates a vector tile search API request into a search containing:\n\n* A `geo_bounding_box` query on the ``. The query uses the `//` tile as a bounding box.\n* A `geotile_grid` or `geohex_grid` aggregation on the ``. The `grid_agg` parameter determines the aggregation type. The aggregation uses the `//` tile as a bounding box.\n* Optionally, a `geo_bounds` aggregation on the ``. The search only includes this aggregation if the `exact_bounds` parameter is `true`.\n* If the optional parameter `with_labels` is `true`, the internal search will include a dynamic runtime field that calls the `getLabelPosition` function of the geometry doc value. This enables the generation of new point features containing suggested geometry labels, so that, for example, multi-polygons will have only one label.\n\nFor example, Elasticsearch may translate a vector tile search API request with a `grid_agg` argument of `geotile` and an `exact_bounds` argument of `true` into the following search\n\n```\nGET my-index/_search\n{\n \"size\": 10000,\n \"query\": {\n \"geo_bounding_box\": {\n \"my-geo-field\": {\n \"top_left\": {\n \"lat\": -40.979898069620134,\n \"lon\": -45\n },\n \"bottom_right\": {\n \"lat\": -66.51326044311186,\n \"lon\": 0\n }\n }\n }\n },\n \"aggregations\": {\n \"grid\": {\n \"geotile_grid\": {\n \"field\": \"my-geo-field\",\n \"precision\": 11,\n \"size\": 65536,\n \"bounds\": {\n \"top_left\": {\n \"lat\": -40.979898069620134,\n \"lon\": -45\n },\n \"bottom_right\": {\n \"lat\": -66.51326044311186,\n \"lon\": 0\n }\n }\n }\n },\n \"bounds\": {\n \"geo_bounds\": {\n \"field\": \"my-geo-field\",\n \"wrap_longitude\": false\n }\n }\n }\n}\n```\n\nThe API returns results as a binary Mapbox vector tile.\nMapbox vector tiles are encoded as Google Protobufs (PBF). By default, the tile contains three layers:\n\n* A `hits` layer containing a feature for each `` value matching the `geo_bounding_box` query.\n* An `aggs` layer containing a feature for each cell of the `geotile_grid` or `geohex_grid`. The layer only contains features for cells with matching data.\n* A meta layer containing:\n * A feature containing a bounding box. By default, this is the bounding box of the tile.\n * Value ranges for any sub-aggregations on the `geotile_grid` or `geohex_grid`.\n * Metadata for the search.\n\nThe API only returns features that can display at its zoom level.\nFor example, if a polygon feature has no area at its zoom level, the API omits it.\nThe API returns errors as UTF-8 encoded JSON.\n\nIMPORTANT: You can specify several options for this API as either a query parameter or request body parameter.\nIf you specify both parameters, the query parameter takes precedence.\n\n**Grid precision for geotile**\n\nFor a `grid_agg` of `geotile`, you can use cells in the `aggs` layer as tiles for lower zoom levels.\n`grid_precision` represents the additional zoom levels available through these cells. The final precision is computed by as follows: ` + grid_precision`.\nFor example, if `` is 7 and `grid_precision` is 8, then the `geotile_grid` aggregation will use a precision of 15.\nThe maximum final precision is 29.\nThe `grid_precision` also determines the number of cells for the grid as follows: `(2^grid_precision) x (2^grid_precision)`.\nFor example, a value of 8 divides the tile into a grid of 256 x 256 cells.\nThe `aggs` layer only contains features for cells with matching data.\n\n**Grid precision for geohex**\n\nFor a `grid_agg` of `geohex`, Elasticsearch uses `` and `grid_precision` to calculate a final precision as follows: ` + grid_precision`.\n\nThis precision determines the H3 resolution of the hexagonal cells produced by the `geohex` aggregation.\nThe following table maps the H3 resolution for each precision.\nFor example, if `` is 3 and `grid_precision` is 3, the precision is 6.\nAt a precision of 6, hexagonal cells have an H3 resolution of 2.\nIf `` is 3 and `grid_precision` is 4, the precision is 7.\nAt a precision of 7, hexagonal cells have an H3 resolution of 3.\n\n| Precision | Unique tile bins | H3 resolution | Unique hex bins |\tRatio |\n| --------- | ---------------- | ------------- | ----------------| ----- |\n| 1 | 4 | 0 | 122 | 30.5 |\n| 2 | 16 | 0 | 122 | 7.625 |\n| 3 | 64 | 1 | 842 | 13.15625 |\n| 4 | 256 | 1 | 842 | 3.2890625 |\n| 5 | 1024 | 2 | 5882 | 5.744140625 |\n| 6 | 4096 | 2 | 5882 | 1.436035156 |\n| 7 | 16384 | 3 | 41162 | 2.512329102 |\n| 8 | 65536 | 3 | 41162 | 0.6280822754 |\n| 9 | 262144 | 4 | 288122 | 1.099098206 |\n| 10 | 1048576 | 4 | 288122 | 0.2747745514 |\n| 11 | 4194304 | 5 | 2016842 | 0.4808526039 |\n| 12 | 16777216 | 6 | 14117882 | 0.8414913416 |\n| 13 | 67108864 | 6 | 14117882 | 0.2103728354 |\n| 14 | 268435456 | 7 | 98825162 | 0.3681524172 |\n| 15 | 1073741824 | 8 | 691776122 | 0.644266719 |\n| 16 | 4294967296 | 8 | 691776122 | 0.1610666797 |\n| 17 | 17179869184 | 9 | 4842432842 | 0.2818666889 |\n| 18 | 68719476736 | 10 | 33897029882 | 0.4932667053 |\n| 19 | 274877906944 | 11 | 237279209162 | 0.8632167343 |\n| 20 | 1099511627776 | 11 | 237279209162 | 0.2158041836 |\n| 21 | 4398046511104 | 12 | 1660954464122 | 0.3776573213 |\n| 22 | 17592186044416 | 13 | 11626681248842 | 0.6609003122 |\n| 23 | 70368744177664 | 13 | 11626681248842 | 0.165225078 |\n| 24 | 281474976710656 | 14 | 81386768741882 | 0.2891438866 |\n| 25 | 1125899906842620 | 15 | 569707381193162 | 0.5060018015 |\n| 26 | 4503599627370500 | 15 | 569707381193162 | 0.1265004504 |\n| 27 | 18014398509482000 | 15 | 569707381193162 | 0.03162511259 |\n| 28 | 72057594037927900 | 15 | 569707381193162 | 0.007906278149 |\n| 29 | 288230376151712000 | 15 | 569707381193162 | 0.001976569537 |\n\nHexagonal cells don't align perfectly on a vector tile.\nSome cells may intersect more than one vector tile.\nTo compute the H3 resolution for each precision, Elasticsearch compares the average density of hexagonal bins at each resolution with the average density of tile bins at each zoom level.\nElasticsearch uses the H3 resolution that is closest to the corresponding geotile density.", "externalDocs": { - "url": "https://github.com/mapbox/vector-tile-spec/blob/master/README.md" + "url": "https://github.com/mapbox/vector-tile-spec/blob/current/README.md" }, "operationId": "search-mvt", "parameters": [ @@ -109926,7 +109926,7 @@ }, "role_descriptors": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-role" }, "description": "An array of role descriptors for this API key.\nWhen it is not specified or it is an empty array, the API key will have a point in time snapshot of permissions of the authenticated user.\nIf you supply role descriptors, the resultant permissions are an intersection of API keys permissions and the authenticated user's permissions thereby limiting the access scope for API keys.\nThe structure of role descriptor is the same as the request for the create role API.\nFor more details, refer to the create or update roles API.\n\nNOTE: Due to the way in which this permission intersection is calculated, it is not possible to create an API key that is a child of another API key, unless the derived key is created without any privileges.\nIn this case, you must explicitly specify a role descriptor with no privileges.\nThe derived API key can be used for authentication; it will not have authority to call Elasticsearch APIs.", "type": "object", diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 9da164a336..fe3250b6f6 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -16757,7 +16757,7 @@ "summary": "Search a vector tile", "description": "Search a vector tile for geospatial values.\nBefore using this API, you should be familiar with the Mapbox vector tile specification.\nThe API returns results as a binary mapbox vector tile.\n\nInternally, Elasticsearch translates a vector tile search API request into a search containing:\n\n* A `geo_bounding_box` query on the ``. The query uses the `//` tile as a bounding box.\n* A `geotile_grid` or `geohex_grid` aggregation on the ``. The `grid_agg` parameter determines the aggregation type. The aggregation uses the `//` tile as a bounding box.\n* Optionally, a `geo_bounds` aggregation on the ``. The search only includes this aggregation if the `exact_bounds` parameter is `true`.\n* If the optional parameter `with_labels` is `true`, the internal search will include a dynamic runtime field that calls the `getLabelPosition` function of the geometry doc value. This enables the generation of new point features containing suggested geometry labels, so that, for example, multi-polygons will have only one label.\n\nFor example, Elasticsearch may translate a vector tile search API request with a `grid_agg` argument of `geotile` and an `exact_bounds` argument of `true` into the following search\n\n```\nGET my-index/_search\n{\n \"size\": 10000,\n \"query\": {\n \"geo_bounding_box\": {\n \"my-geo-field\": {\n \"top_left\": {\n \"lat\": -40.979898069620134,\n \"lon\": -45\n },\n \"bottom_right\": {\n \"lat\": -66.51326044311186,\n \"lon\": 0\n }\n }\n }\n },\n \"aggregations\": {\n \"grid\": {\n \"geotile_grid\": {\n \"field\": \"my-geo-field\",\n \"precision\": 11,\n \"size\": 65536,\n \"bounds\": {\n \"top_left\": {\n \"lat\": -40.979898069620134,\n \"lon\": -45\n },\n \"bottom_right\": {\n \"lat\": -66.51326044311186,\n \"lon\": 0\n }\n }\n }\n },\n \"bounds\": {\n \"geo_bounds\": {\n \"field\": \"my-geo-field\",\n \"wrap_longitude\": false\n }\n }\n }\n}\n```\n\nThe API returns results as a binary Mapbox vector tile.\nMapbox vector tiles are encoded as Google Protobufs (PBF). By default, the tile contains three layers:\n\n* A `hits` layer containing a feature for each `` value matching the `geo_bounding_box` query.\n* An `aggs` layer containing a feature for each cell of the `geotile_grid` or `geohex_grid`. The layer only contains features for cells with matching data.\n* A meta layer containing:\n * A feature containing a bounding box. By default, this is the bounding box of the tile.\n * Value ranges for any sub-aggregations on the `geotile_grid` or `geohex_grid`.\n * Metadata for the search.\n\nThe API only returns features that can display at its zoom level.\nFor example, if a polygon feature has no area at its zoom level, the API omits it.\nThe API returns errors as UTF-8 encoded JSON.\n\nIMPORTANT: You can specify several options for this API as either a query parameter or request body parameter.\nIf you specify both parameters, the query parameter takes precedence.\n\n**Grid precision for geotile**\n\nFor a `grid_agg` of `geotile`, you can use cells in the `aggs` layer as tiles for lower zoom levels.\n`grid_precision` represents the additional zoom levels available through these cells. The final precision is computed by as follows: ` + grid_precision`.\nFor example, if `` is 7 and `grid_precision` is 8, then the `geotile_grid` aggregation will use a precision of 15.\nThe maximum final precision is 29.\nThe `grid_precision` also determines the number of cells for the grid as follows: `(2^grid_precision) x (2^grid_precision)`.\nFor example, a value of 8 divides the tile into a grid of 256 x 256 cells.\nThe `aggs` layer only contains features for cells with matching data.\n\n**Grid precision for geohex**\n\nFor a `grid_agg` of `geohex`, Elasticsearch uses `` and `grid_precision` to calculate a final precision as follows: ` + grid_precision`.\n\nThis precision determines the H3 resolution of the hexagonal cells produced by the `geohex` aggregation.\nThe following table maps the H3 resolution for each precision.\nFor example, if `` is 3 and `grid_precision` is 3, the precision is 6.\nAt a precision of 6, hexagonal cells have an H3 resolution of 2.\nIf `` is 3 and `grid_precision` is 4, the precision is 7.\nAt a precision of 7, hexagonal cells have an H3 resolution of 3.\n\n| Precision | Unique tile bins | H3 resolution | Unique hex bins |\tRatio |\n| --------- | ---------------- | ------------- | ----------------| ----- |\n| 1 | 4 | 0 | 122 | 30.5 |\n| 2 | 16 | 0 | 122 | 7.625 |\n| 3 | 64 | 1 | 842 | 13.15625 |\n| 4 | 256 | 1 | 842 | 3.2890625 |\n| 5 | 1024 | 2 | 5882 | 5.744140625 |\n| 6 | 4096 | 2 | 5882 | 1.436035156 |\n| 7 | 16384 | 3 | 41162 | 2.512329102 |\n| 8 | 65536 | 3 | 41162 | 0.6280822754 |\n| 9 | 262144 | 4 | 288122 | 1.099098206 |\n| 10 | 1048576 | 4 | 288122 | 0.2747745514 |\n| 11 | 4194304 | 5 | 2016842 | 0.4808526039 |\n| 12 | 16777216 | 6 | 14117882 | 0.8414913416 |\n| 13 | 67108864 | 6 | 14117882 | 0.2103728354 |\n| 14 | 268435456 | 7 | 98825162 | 0.3681524172 |\n| 15 | 1073741824 | 8 | 691776122 | 0.644266719 |\n| 16 | 4294967296 | 8 | 691776122 | 0.1610666797 |\n| 17 | 17179869184 | 9 | 4842432842 | 0.2818666889 |\n| 18 | 68719476736 | 10 | 33897029882 | 0.4932667053 |\n| 19 | 274877906944 | 11 | 237279209162 | 0.8632167343 |\n| 20 | 1099511627776 | 11 | 237279209162 | 0.2158041836 |\n| 21 | 4398046511104 | 12 | 1660954464122 | 0.3776573213 |\n| 22 | 17592186044416 | 13 | 11626681248842 | 0.6609003122 |\n| 23 | 70368744177664 | 13 | 11626681248842 | 0.165225078 |\n| 24 | 281474976710656 | 14 | 81386768741882 | 0.2891438866 |\n| 25 | 1125899906842620 | 15 | 569707381193162 | 0.5060018015 |\n| 26 | 4503599627370500 | 15 | 569707381193162 | 0.1265004504 |\n| 27 | 18014398509482000 | 15 | 569707381193162 | 0.03162511259 |\n| 28 | 72057594037927900 | 15 | 569707381193162 | 0.007906278149 |\n| 29 | 288230376151712000 | 15 | 569707381193162 | 0.001976569537 |\n\nHexagonal cells don't align perfectly on a vector tile.\nSome cells may intersect more than one vector tile.\nTo compute the H3 resolution for each precision, Elasticsearch compares the average density of hexagonal bins at each resolution with the average density of tile bins at each zoom level.\nElasticsearch uses the H3 resolution that is closest to the corresponding geotile density.", "externalDocs": { - "url": "https://github.com/mapbox/vector-tile-spec/blob/master/README.md" + "url": "https://github.com/mapbox/vector-tile-spec/blob/current/README.md" }, "operationId": "search-mvt-1", "parameters": [ @@ -16815,7 +16815,7 @@ "summary": "Search a vector tile", "description": "Search a vector tile for geospatial values.\nBefore using this API, you should be familiar with the Mapbox vector tile specification.\nThe API returns results as a binary mapbox vector tile.\n\nInternally, Elasticsearch translates a vector tile search API request into a search containing:\n\n* A `geo_bounding_box` query on the ``. The query uses the `//` tile as a bounding box.\n* A `geotile_grid` or `geohex_grid` aggregation on the ``. The `grid_agg` parameter determines the aggregation type. The aggregation uses the `//` tile as a bounding box.\n* Optionally, a `geo_bounds` aggregation on the ``. The search only includes this aggregation if the `exact_bounds` parameter is `true`.\n* If the optional parameter `with_labels` is `true`, the internal search will include a dynamic runtime field that calls the `getLabelPosition` function of the geometry doc value. This enables the generation of new point features containing suggested geometry labels, so that, for example, multi-polygons will have only one label.\n\nFor example, Elasticsearch may translate a vector tile search API request with a `grid_agg` argument of `geotile` and an `exact_bounds` argument of `true` into the following search\n\n```\nGET my-index/_search\n{\n \"size\": 10000,\n \"query\": {\n \"geo_bounding_box\": {\n \"my-geo-field\": {\n \"top_left\": {\n \"lat\": -40.979898069620134,\n \"lon\": -45\n },\n \"bottom_right\": {\n \"lat\": -66.51326044311186,\n \"lon\": 0\n }\n }\n }\n },\n \"aggregations\": {\n \"grid\": {\n \"geotile_grid\": {\n \"field\": \"my-geo-field\",\n \"precision\": 11,\n \"size\": 65536,\n \"bounds\": {\n \"top_left\": {\n \"lat\": -40.979898069620134,\n \"lon\": -45\n },\n \"bottom_right\": {\n \"lat\": -66.51326044311186,\n \"lon\": 0\n }\n }\n }\n },\n \"bounds\": {\n \"geo_bounds\": {\n \"field\": \"my-geo-field\",\n \"wrap_longitude\": false\n }\n }\n }\n}\n```\n\nThe API returns results as a binary Mapbox vector tile.\nMapbox vector tiles are encoded as Google Protobufs (PBF). By default, the tile contains three layers:\n\n* A `hits` layer containing a feature for each `` value matching the `geo_bounding_box` query.\n* An `aggs` layer containing a feature for each cell of the `geotile_grid` or `geohex_grid`. The layer only contains features for cells with matching data.\n* A meta layer containing:\n * A feature containing a bounding box. By default, this is the bounding box of the tile.\n * Value ranges for any sub-aggregations on the `geotile_grid` or `geohex_grid`.\n * Metadata for the search.\n\nThe API only returns features that can display at its zoom level.\nFor example, if a polygon feature has no area at its zoom level, the API omits it.\nThe API returns errors as UTF-8 encoded JSON.\n\nIMPORTANT: You can specify several options for this API as either a query parameter or request body parameter.\nIf you specify both parameters, the query parameter takes precedence.\n\n**Grid precision for geotile**\n\nFor a `grid_agg` of `geotile`, you can use cells in the `aggs` layer as tiles for lower zoom levels.\n`grid_precision` represents the additional zoom levels available through these cells. The final precision is computed by as follows: ` + grid_precision`.\nFor example, if `` is 7 and `grid_precision` is 8, then the `geotile_grid` aggregation will use a precision of 15.\nThe maximum final precision is 29.\nThe `grid_precision` also determines the number of cells for the grid as follows: `(2^grid_precision) x (2^grid_precision)`.\nFor example, a value of 8 divides the tile into a grid of 256 x 256 cells.\nThe `aggs` layer only contains features for cells with matching data.\n\n**Grid precision for geohex**\n\nFor a `grid_agg` of `geohex`, Elasticsearch uses `` and `grid_precision` to calculate a final precision as follows: ` + grid_precision`.\n\nThis precision determines the H3 resolution of the hexagonal cells produced by the `geohex` aggregation.\nThe following table maps the H3 resolution for each precision.\nFor example, if `` is 3 and `grid_precision` is 3, the precision is 6.\nAt a precision of 6, hexagonal cells have an H3 resolution of 2.\nIf `` is 3 and `grid_precision` is 4, the precision is 7.\nAt a precision of 7, hexagonal cells have an H3 resolution of 3.\n\n| Precision | Unique tile bins | H3 resolution | Unique hex bins |\tRatio |\n| --------- | ---------------- | ------------- | ----------------| ----- |\n| 1 | 4 | 0 | 122 | 30.5 |\n| 2 | 16 | 0 | 122 | 7.625 |\n| 3 | 64 | 1 | 842 | 13.15625 |\n| 4 | 256 | 1 | 842 | 3.2890625 |\n| 5 | 1024 | 2 | 5882 | 5.744140625 |\n| 6 | 4096 | 2 | 5882 | 1.436035156 |\n| 7 | 16384 | 3 | 41162 | 2.512329102 |\n| 8 | 65536 | 3 | 41162 | 0.6280822754 |\n| 9 | 262144 | 4 | 288122 | 1.099098206 |\n| 10 | 1048576 | 4 | 288122 | 0.2747745514 |\n| 11 | 4194304 | 5 | 2016842 | 0.4808526039 |\n| 12 | 16777216 | 6 | 14117882 | 0.8414913416 |\n| 13 | 67108864 | 6 | 14117882 | 0.2103728354 |\n| 14 | 268435456 | 7 | 98825162 | 0.3681524172 |\n| 15 | 1073741824 | 8 | 691776122 | 0.644266719 |\n| 16 | 4294967296 | 8 | 691776122 | 0.1610666797 |\n| 17 | 17179869184 | 9 | 4842432842 | 0.2818666889 |\n| 18 | 68719476736 | 10 | 33897029882 | 0.4932667053 |\n| 19 | 274877906944 | 11 | 237279209162 | 0.8632167343 |\n| 20 | 1099511627776 | 11 | 237279209162 | 0.2158041836 |\n| 21 | 4398046511104 | 12 | 1660954464122 | 0.3776573213 |\n| 22 | 17592186044416 | 13 | 11626681248842 | 0.6609003122 |\n| 23 | 70368744177664 | 13 | 11626681248842 | 0.165225078 |\n| 24 | 281474976710656 | 14 | 81386768741882 | 0.2891438866 |\n| 25 | 1125899906842620 | 15 | 569707381193162 | 0.5060018015 |\n| 26 | 4503599627370500 | 15 | 569707381193162 | 0.1265004504 |\n| 27 | 18014398509482000 | 15 | 569707381193162 | 0.03162511259 |\n| 28 | 72057594037927900 | 15 | 569707381193162 | 0.007906278149 |\n| 29 | 288230376151712000 | 15 | 569707381193162 | 0.001976569537 |\n\nHexagonal cells don't align perfectly on a vector tile.\nSome cells may intersect more than one vector tile.\nTo compute the H3 resolution for each precision, Elasticsearch compares the average density of hexagonal bins at each resolution with the average density of tile bins at each zoom level.\nElasticsearch uses the H3 resolution that is closest to the corresponding geotile density.", "externalDocs": { - "url": "https://github.com/mapbox/vector-tile-spec/blob/master/README.md" + "url": "https://github.com/mapbox/vector-tile-spec/blob/current/README.md" }, "operationId": "search-mvt", "parameters": [ @@ -64811,7 +64811,7 @@ }, "role_descriptors": { "externalDocs": { - "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html" + "url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-role" }, "description": "An array of role descriptors for this API key.\nWhen it is not specified or it is an empty array, the API key will have a point in time snapshot of permissions of the authenticated user.\nIf you supply role descriptors, the resultant permissions are an intersection of API keys permissions and the authenticated user's permissions thereby limiting the access scope for API keys.\nThe structure of role descriptor is the same as the request for the create role API.\nFor more details, refer to the create or update roles API.\n\nNOTE: Due to the way in which this permission intersection is calculated, it is not possible to create an API key that is a child of another API key, unless the derived key is created without any privileges.\nIn this case, you must explicitly specify a role descriptor with no privileges.\nThe derived API key can be used for authentication; it will not have authority to call Elasticsearch APIs.", "type": "object", diff --git a/output/schema/schema.json b/output/schema/schema.json index 716ca0d374..1d37f84bf9 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -174,7 +174,7 @@ "description": "Delete an async search.\n\nIf the asynchronous search is still running, it is cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", "docId": "async-search", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit", "name": "async_search.delete", "request": { "name": "Request", @@ -211,7 +211,7 @@ "description": "Get async search results.\n\nRetrieve the results of a previously submitted asynchronous search request.\nIf the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", "docId": "async-search", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit", "name": "async_search.get", "request": { "name": "Request", @@ -248,7 +248,7 @@ "description": "Get the async search status.\n\nGet the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", "docId": "async-search", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit", "name": "async_search.status", "request": { "name": "Request", @@ -285,7 +285,7 @@ "description": "Run an async search.\n\nWhen the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.\n\nWarning: Asynchronous search does not support scroll or search requests that include only the suggest section.\n\nBy default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", "docId": "async-search", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit", "name": "async_search.submit", "request": { "name": "Request", @@ -326,7 +326,7 @@ }, "description": "Delete an autoscaling policy.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", "docId": "autoscaling-delete-autoscaling-policy", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-delete-autoscaling-policy.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-delete-autoscaling-policy", "extDocId": "autoscaling", "extDocUrl": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html", "name": "autoscaling.delete_autoscaling_policy", @@ -360,7 +360,7 @@ }, "description": "Get the autoscaling capacity.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nThis API gets the current autoscaling capacity based on the configured autoscaling policy.\nIt will return information to size the cluster appropriately to the current workload.\n\nThe `required_capacity` is calculated as the maximum of the `required_capacity` result of all individual deciders that are enabled for the policy.\n\nThe operator should verify that the `current_nodes` match the operator’s knowledge of the cluster to avoid making autoscaling decisions based on stale or incomplete information.\n\nThe response contains decider-specific information you can use to diagnose how and why autoscaling determined a certain capacity was required.\nThis information is provided for diagnosis only.\nDo not use this information to make autoscaling decisions.", "docId": "autoscaling-get-autoscaling-capacity", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-get-autoscaling-capacity.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-get-autoscaling-capacity", "extDocId": "autoscaling", "extDocUrl": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html", "name": "autoscaling.get_autoscaling_capacity", @@ -394,7 +394,7 @@ }, "description": "Get an autoscaling policy.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", "docId": "autoscaling-get-autoscaling-capacity", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-get-autoscaling-capacity.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-get-autoscaling-capacity", "extDocId": "autoscaling", "extDocUrl": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html", "name": "autoscaling.get_autoscaling_policy", @@ -428,7 +428,7 @@ }, "description": "Create or update an autoscaling policy.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", "docId": "autoscaling-put-autoscaling-policy", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-put-autoscaling-policy.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-put-autoscaling-policy", "extDocId": "autoscaling", "extDocUrl": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html", "name": "autoscaling.put_autoscaling_policy", @@ -469,7 +469,7 @@ "description": "Bulk index or delete documents.\nPerform multiple `index`, `create`, `delete`, and `update` actions in a single request.\nThis reduces overhead and can greatly increase indexing speed.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To use the `create` action, you must have the `create_doc`, `create`, `index`, or `write` index privilege. Data streams support only the `create` action.\n* To use the `index` action, you must have the `create`, `index`, or `write` index privilege.\n* To use the `delete` action, you must have the `delete` or `write` index privilege.\n* To use the `update` action, you must have the `index` or `write` index privilege.\n* To automatically create a data stream or index with a bulk API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n* To make the result of a bulk operation visible to search using the `refresh` parameter, you must have the `maintenance` or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nThe actions are specified in the request body using a newline delimited JSON (NDJSON) structure:\n\n```\naction_and_meta_data\\n\noptional_source\\n\naction_and_meta_data\\n\noptional_source\\n\n....\naction_and_meta_data\\n\noptional_source\\n\n```\n\nThe `index` and `create` actions expect a source on the next line and have the same semantics as the `op_type` parameter in the standard index API.\nA `create` action fails if a document with the same ID already exists in the target\nAn `index` action adds or replaces a document as necessary.\n\nNOTE: Data streams support only the `create` action.\nTo update or delete a document in a data stream, you must target the backing index containing the document.\n\nAn `update` action expects that the partial doc, upsert, and script and its options are specified on the next line.\n\nA `delete` action does not expect a source on the next line and has the same semantics as the standard delete API.\n\nNOTE: The final line of data must end with a newline character (`\\n`).\nEach newline character may be preceded by a carriage return (`\\r`).\nWhen sending NDJSON data to the `_bulk` endpoint, use a `Content-Type` header of `application/json` or `application/x-ndjson`.\nBecause this format uses literal newline characters (`\\n`) as delimiters, make sure that the JSON actions and sources are not pretty printed.\n\nIf you provide a target in the request path, it is used for any actions that don't explicitly specify an `_index` argument.\n\nA note on the format: the idea here is to make processing as fast as possible.\nAs some of the actions are redirected to other shards on other nodes, only `action_meta_data` is parsed on the receiving node side.\n\nClient libraries using this protocol should try and strive to do something similar on the client side, and reduce buffering as much as possible.\n\nThere is no \"correct\" number of actions to perform in a single bulk request.\nExperiment with different settings to find the optimal size for your particular workload.\nNote that Elasticsearch limits the maximum size of a HTTP request to 100mb by default so clients must ensure that no request exceeds this size.\nIt is not possible to index a single document that exceeds the size limit, so you must pre-process any such documents into smaller pieces before sending them to Elasticsearch.\nFor instance, split documents into pages or chapters before indexing them, or store raw binary data in a system outside Elasticsearch and replace the raw data with a link to the external system in the documents that you send to Elasticsearch.\n\n**Client suppport for bulk requests**\n\nSome of the officially supported clients provide helpers to assist with bulk requests and reindexing:\n\n* Go: Check out `esutil.BulkIndexer`\n* Perl: Check out `Search::Elasticsearch::Client::5_0::Bulk` and `Search::Elasticsearch::Client::5_0::Scroll`\n* Python: Check out `elasticsearch.helpers.*`\n* JavaScript: Check out `client.helpers.*`\n* .NET: Check out `BulkAllObservable`\n* PHP: Check out bulk indexing.\n\n**Submitting bulk requests with cURL**\n\nIf you're providing text file input to `curl`, you must use the `--data-binary` flag instead of plain `-d`.\nThe latter doesn't preserve newlines. For example:\n\n```\n$ cat requests\n{ \"index\" : { \"_index\" : \"test\", \"_id\" : \"1\" } }\n{ \"field1\" : \"value1\" }\n$ curl -s -H \"Content-Type: application/x-ndjson\" -XPOST localhost:9200/_bulk --data-binary \"@requests\"; echo\n{\"took\":7, \"errors\": false, \"items\":[{\"index\":{\"_index\":\"test\",\"_id\":\"1\",\"_version\":1,\"result\":\"created\",\"forced_refresh\":false}}]}\n```\n\n**Optimistic concurrency control**\n\nEach `index` and `delete` action within a bulk API call may include the `if_seq_no` and `if_primary_term` parameters in their respective action and meta data lines.\nThe `if_seq_no` and `if_primary_term` parameters control how operations are run, based on the last modification to existing documents. See Optimistic concurrency control for more details.\n\n**Versioning**\n\nEach bulk item can include the version value using the `version` field.\nIt automatically follows the behavior of the index or delete operation based on the `_version` mapping.\nIt also support the `version_type`.\n\n**Routing**\n\nEach bulk item can include the routing value using the `routing` field.\nIt automatically follows the behavior of the index or delete operation based on the `_routing` mapping.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Wait for active shards**\n\nWhen making bulk calls, you can set the `wait_for_active_shards` parameter to require a minimum number of shard copies to be active before starting to process the bulk request.\n\n**Refresh**\n\nControl when the changes made by this request are visible to search.\n\nNOTE: Only the shards that receive the bulk request will be affected by refresh.\nImagine a `_bulk?refresh=wait_for` request with three documents in it that happen to be routed to different shards in an index with five shards.\nThe request will only wait for those three shards to refresh.\nThe other two shards that make up the index do not participate in the `_bulk` request at all.", "docId": "docs-bulk", "docTag": "document", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-bulk.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk", "name": "bulk", "request": { "name": "Request", @@ -540,7 +540,7 @@ }, "description": "Get aliases.\n\nGet the cluster's index aliases, including filter and routing information.\nThis API does not return data stream aliases.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.", "docId": "cat-alias", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-alias.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-aliases", "name": "cat.aliases", "privileges": { "index": [ @@ -587,7 +587,7 @@ }, "description": "Get shard allocation information.\n\nGet a snapshot of the number of shards allocated to each data node and their disk space.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", "docId": "cat-allocation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-allocation.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-allocation", "name": "cat.allocation", "privileges": { "cluster": [ @@ -635,7 +635,7 @@ }, "description": "Get component templates.\n\nGet information about component templates in a cluster.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the get component template API.", "docId": "cat-component-templates", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-component-templates.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-component-templates", "name": "cat.component_templates", "privileges": { "cluster": [ @@ -682,7 +682,7 @@ }, "description": "Get a document count.\n\nGet quick access to a document count for a data stream, an index, or an entire cluster.\nThe document count only includes live documents, not deleted documents which have not yet been removed by the merge process.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the count API.", "docId": "cat-count", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-count.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-count", "name": "cat.count", "privileges": { "index": [ @@ -729,7 +729,7 @@ }, "description": "Get field data cache information.\n\nGet the amount of heap memory currently used by the field data cache on every data node in the cluster.\n\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the nodes stats API.", "docId": "cat-fielddata", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-fielddata.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-fielddata", "name": "cat.fielddata", "privileges": { "cluster": [ @@ -776,7 +776,7 @@ }, "description": "Get the cluster health status.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use the cluster health API.\nThis API is often used to check malfunctioning clusters.\nTo help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats:\n`HH:MM:SS`, which is human-readable but includes no date information;\n`Unix epoch time`, which is machine-sortable and includes date information.\nThe latter format is useful for cluster recoveries that take multiple days.\nYou can use the cat health API to verify cluster health across multiple nodes.\nYou also can use the API to track the recovery of a large cluster over a longer period of time.", "docId": "cat-health", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-health.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-health", "name": "cat.health", "privileges": { "cluster": [ @@ -817,7 +817,7 @@ }, "description": "Get CAT help.\n\nGet help for the CAT APIs.", "docId": "cat", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cat", "name": "cat.help", "request": { "name": "Request", @@ -852,7 +852,7 @@ }, "description": "Get index information.\n\nGet high-level information about indices in a cluster, including backing indices for data streams.\n\nUse this request to get the following information for each index in a cluster:\n- shard count\n- document count\n- deleted document count\n- primary store size\n- total store size of all shards, including shard replicas\n\nThese metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents.\nTo get an accurate count of Elasticsearch documents, use the cat count or count APIs.\n\nCAT APIs are only intended for human consumption using the command line or Kibana console.\nThey are not intended for use by applications. For application consumption, use an index endpoint.", "docId": "cat-indices", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-indices.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-indices", "name": "cat.indices", "privileges": { "cluster": [ @@ -902,7 +902,7 @@ }, "description": "Get master node information.\n\nGet information about the master node, including the ID, bound IP address, and name.\n\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", "docId": "cat-master", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-master.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-master", "name": "cat.master", "privileges": { "cluster": [ @@ -944,7 +944,7 @@ }, "description": "Get data frame analytics jobs.\n\nGet configuration and usage information about data frame analytics jobs.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get data frame analytics jobs statistics API.", "docId": "cat-dfanalytics", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-dfanalytics.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-data-frame-analytics", "name": "cat.ml_data_frame_analytics", "privileges": { "cluster": [ @@ -992,7 +992,7 @@ }, "description": "Get datafeeds.\n\nGet configuration and usage information about datafeeds.\nThis API returns a maximum of 10,000 datafeeds.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage`\ncluster privileges to use this API.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get datafeed statistics API.", "docId": "cat-datafeeds", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-datafeeds.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-datafeeds", "name": "cat.ml_datafeeds", "privileges": { "cluster": [ @@ -1040,7 +1040,7 @@ }, "description": "Get anomaly detection jobs.\n\nGet configuration and usage information for anomaly detection jobs.\nThis API returns a maximum of 10,000 jobs.\nIf the Elasticsearch security features are enabled, you must have `monitor_ml`,\n`monitor`, `manage_ml`, or `manage` cluster privileges to use this API.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get anomaly detection job statistics API.", "docId": "cat-anomaly-detectors", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-anomaly-detectors.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-jobs", "name": "cat.ml_jobs", "privileges": { "cluster": [ @@ -1088,7 +1088,7 @@ }, "description": "Get trained models.\n\nGet configuration and usage information about inference trained models.\n\nIMPORTANT: CAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get trained models statistics API.", "docId": "cat-trained-model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-trained-model.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-trained-models", "name": "cat.ml_trained_models", "privileges": { "cluster": [ @@ -1135,7 +1135,7 @@ }, "description": "Get node attribute information.\n\nGet information about custom node attributes.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", "docId": "cat-nodeattrs", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-nodeattrs.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodeattrs", "name": "cat.nodeattrs", "privileges": { "cluster": [ @@ -1176,7 +1176,7 @@ }, "description": "Get node information.\n\nGet information about the nodes in a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", "docId": "cat-nodes", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-nodes.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodes", "name": "cat.nodes", "privileges": { "cluster": [ @@ -1217,7 +1217,7 @@ }, "description": "Get pending task information.\n\nGet information about cluster-level changes that have not yet taken effect.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.", "docId": "cat-pending-tasks", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-pending-tasks.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-pending-tasks", "name": "cat.pending_tasks", "privileges": { "cluster": [ @@ -1258,7 +1258,7 @@ }, "description": "Get plugin information.\n\nGet a list of plugins running on each node of a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", "docId": "cat-plugins", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-plugins.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-plugins", "name": "cat.plugins", "privileges": { "cluster": [ @@ -1299,7 +1299,7 @@ }, "description": "Get shard recovery information.\n\nGet information about ongoing and completed shard recoveries.\nShard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing.\nFor data streams, the API returns information about the stream’s backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.", "docId": "cat-recovery", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-recovery.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-recovery", "name": "cat.recovery", "privileges": { "cluster": [ @@ -1350,7 +1350,7 @@ }, "description": "Get snapshot repository information.\n\nGet a list of snapshot repositories for a cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.", "docId": "cat-repositories", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-repositories.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-repositories", "name": "cat.repositories", "privileges": { "cluster": [ @@ -1391,7 +1391,7 @@ }, "description": "Get segment information.\n\nGet low-level information about the Lucene segments in index shards.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.", "docId": "cat-segments", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-segments.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-segments", "name": "cat.segments", "privileges": { "cluster": [ @@ -1441,7 +1441,7 @@ }, "description": "Get shard information.\n\nGet information about the shards in a cluster.\nFor data streams, the API returns information about the backing indices.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.", "docId": "cat-shards", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-shards.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-shards", "name": "cat.shards", "privileges": { "cluster": [ @@ -1492,7 +1492,7 @@ }, "description": "Get snapshot information.\n\nGet information about the snapshots stored in one or more repositories.\nA snapshot is a backup of an index or running Elasticsearch cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.", "docId": "cat-snapshots", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-snapshots.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-snapshots", "name": "cat.snapshots", "privileges": { "cluster": [ @@ -1540,7 +1540,7 @@ }, "description": "Get task information.\n\nGet information about tasks currently running in the cluster.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.", "docId": "cat-tasks", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-tasks.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-tasks", "name": "cat.tasks", "privileges": { "cluster": [ @@ -1582,7 +1582,7 @@ }, "description": "Get index template information.\n\nGet information about the index templates in a cluster.\nYou can use index templates to apply index settings and field mappings to new indices at creation.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.", "docId": "cat-templates", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-templates.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-templates", "name": "cat.templates", "privileges": { "cluster": [ @@ -1629,7 +1629,7 @@ }, "description": "Get thread pool statistics.\n\nGet thread pool statistics for each node in a cluster.\nReturned information includes all built-in thread pools and custom thread pools.\nIMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.", "docId": "cat-thread-pool", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-thread-pool.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-thread-pool", "name": "cat.thread_pool", "privileges": { "cluster": [ @@ -1677,7 +1677,7 @@ }, "description": "Get transform information.\n\nGet configuration and usage information about transforms.\n\nCAT APIs are only intended for human consumption using the Kibana\nconsole or command line. They are not intended for use by applications. For\napplication consumption, use the get transform statistics API.", "docId": "cat-transforms", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-transforms.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-transforms", "name": "cat.transforms", "privileges": { "cluster": [ @@ -1721,7 +1721,7 @@ }, "description": "Delete auto-follow patterns.\nDelete a collection of cross-cluster replication auto-follow patterns.", "docId": "ccr-delete-auto-follow-pattern", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-delete-auto-follow-pattern.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-delete-auto-follow-pattern", "extDocId": "ccr-auto-follow", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-auto-follow.html", "name": "ccr.delete_auto_follow_pattern", @@ -1755,7 +1755,7 @@ }, "description": "Create a follower.\nCreate a cross-cluster replication follower index that follows a specific leader index.\nWhen the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index.", "docId": "ccr-put-follow", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-put-follow.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow", "name": "ccr.follow", "request": { "name": "Request", @@ -1790,7 +1790,7 @@ }, "description": "Get follower information.\nGet information about all cross-cluster replication follower indices.\nFor example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused.", "docId": "ccr-get-follow-info", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-get-follow-info.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow-info", "extDocId": "ccr", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/xpack-ccr.html", "name": "ccr.follow_info", @@ -1824,7 +1824,7 @@ }, "description": "Get follower stats.\nGet cross-cluster replication follower stats.\nThe API returns shard-level stats about the \"following tasks\" associated with each shard for the specified indices.", "docId": "ccr-get-follow-stats", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-get-follow-stats.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow-stats", "extDocId": "ccr", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/xpack-ccr.html", "name": "ccr.follow_stats", @@ -1858,7 +1858,7 @@ }, "description": "Forget a follower.\nRemove the cross-cluster replication follower retention leases from the leader.\n\nA following index takes out retention leases on its leader index.\nThese leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication.\nWhen a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed.\nHowever, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable.\nWhile the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index.\nThis API exists to enable manually removing the leases when the unfollow API is unable to do so.\n\nNOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader.\nThe only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked.", "docId": "ccr-post-forget-follower", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-post-forget-follower.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-forget-follower", "extDocId": "ccr", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/xpack-ccr.html", "name": "ccr.forget_follower", @@ -1895,7 +1895,7 @@ }, "description": "Get auto-follow patterns.\nGet cross-cluster replication auto-follow patterns.", "docId": "ccr-get-auto-follow-pattern", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-get-auto-follow-pattern.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-get-auto-follow-pattern-1", "extDocId": "ccr-auto-follow", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-auto-follow.html", "name": "ccr.get_auto_follow_pattern", @@ -1935,7 +1935,7 @@ }, "description": "Pause an auto-follow pattern.\nPause a cross-cluster replication auto-follow pattern.\nWhen the API returns, the auto-follow pattern is inactive.\nNew indices that are created on the remote cluster and match the auto-follow patterns are ignored.\n\nYou can resume auto-following with the resume auto-follow pattern API.\nWhen it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns.\nRemote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim.", "docId": "ccr-pause-auto-follow-pattern", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-pause-auto-follow-pattern.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-pause-auto-follow-pattern", "extDocId": "ccr-auto-follow", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-auto-follow.html", "name": "ccr.pause_auto_follow_pattern", @@ -1969,7 +1969,7 @@ }, "description": "Pause a follower.\nPause a cross-cluster replication follower index.\nThe follower index will not fetch any additional operations from the leader index.\nYou can resume following with the resume follower API.\nYou can pause and resume a follower index to change the configuration of the following task.", "docId": "ccr-post-pause-follow", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-post-pause-follow.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-pause-follow", "name": "ccr.pause_follow", "request": { "name": "Request", @@ -2001,7 +2001,7 @@ }, "description": "Create or update auto-follow patterns.\nCreate a collection of cross-cluster replication auto-follow patterns for a remote cluster.\nNewly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices.\nIndices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern.\n\nThis API can also be used to update auto-follow patterns.\nNOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns.", "docId": "ccr-put-auto-follow-pattern", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-put-auto-follow-pattern.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-put-auto-follow-pattern", "extDocId": "ccr-auto-follow", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-auto-follow.html", "name": "ccr.put_auto_follow_pattern", @@ -2038,7 +2038,7 @@ }, "description": "Resume an auto-follow pattern.\nResume a cross-cluster replication auto-follow pattern that was paused.\nThe auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster.\nRemote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim.", "docId": "ccr-resume-auto-follow-pattern", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-resume-auto-follow-pattern.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-resume-auto-follow-pattern", "extDocId": "ccr-auto-follow", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-auto-follow.html", "name": "ccr.resume_auto_follow_pattern", @@ -2072,7 +2072,7 @@ }, "description": "Resume a follower.\nResume a cross-cluster replication follower index that was paused.\nThe follower index could have been paused with the pause follower API.\nAlternatively it could be paused due to replication that cannot be retried due to failures during following tasks.\nWhen this API returns, the follower index will resume fetching operations from the leader index.", "docId": "ccr-post-resume-follow", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-post-resume-follow.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-resume-follow", "extDocId": "ccr", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/xpack-ccr.html", "name": "ccr.resume_follow", @@ -2109,7 +2109,7 @@ }, "description": "Get cross-cluster replication stats.\nThis API returns stats about auto-following and the same shard-level stats as the get follower stats API.", "docId": "ccr-get-stats", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-get-stats.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-stats", "name": "ccr.stats", "request": { "name": "Request", @@ -2141,7 +2141,7 @@ }, "description": "Unfollow an index.\nConvert a cross-cluster replication follower index to a regular index.\nThe API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.\nThe follower index must be paused and closed before you call the unfollow API.\n\nNOTE: Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation.", "docId": "ccr-post-unfollow", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-post-unfollow.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-unfollow", "extDocId": "ccr", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/xpack-ccr.html", "name": "ccr.unfollow", @@ -2179,7 +2179,7 @@ "description": "Clear a scrolling search.\nClear the search context and results for a scrolling search.", "docId": "clear-scroll-api", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clear-scroll-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-clear-scroll", "extDocId": "scroll-search-results", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/paginate-search-results.html#scroll-search-results", "name": "clear_scroll", @@ -2232,7 +2232,7 @@ "description": "Close a point in time.\nA point in time must be opened explicitly before being used in search requests.\nThe `keep_alive` parameter tells Elasticsearch how long it should persist.\nA point in time is automatically closed when the `keep_alive` period has elapsed.\nHowever, keeping points in time has a cost; close them as soon as they are no longer required for search requests.", "docId": "point-in-time-api", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/point-in-time-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time", "name": "close_point_in_time", "request": { "name": "Request", @@ -2272,7 +2272,7 @@ "description": "Explain the shard allocations.\nGet explanations for shard allocations in the cluster.\nFor unassigned shards, it provides an explanation for why the shard is unassigned.\nFor assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node.\nThis API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise.", "docId": "cluster-allocation-explain", "docTag": "cluster", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-allocation-explain.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-allocation-explain", "name": "cluster.allocation_explain", "request": { "name": "Request", @@ -2313,7 +2313,7 @@ "description": "Delete component templates.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.", "docId": "indices-component-template", "docTag": "indices", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-component-template.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template", "name": "cluster.delete_component_template", "privileges": { "cluster": [ @@ -2350,7 +2350,7 @@ }, "description": "Clear cluster voting config exclusions.\nRemove master-eligible nodes from the voting configuration exclusion list.", "docId": "voting-config-exclusions", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/voting-config-exclusions.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-post-voting-config-exclusions", "extDocId": "add-nodes", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/add-elasticsearch-nodes.html", "name": "cluster.delete_voting_config_exclusions", @@ -2389,7 +2389,7 @@ "description": "Check component templates.\nReturns information about whether a particular component template exists.", "docId": "indices-component-template", "docTag": "indices", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-component-template.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template", "name": "cluster.exists_component_template", "request": { "name": "Request", @@ -2426,7 +2426,7 @@ "description": "Get component templates.\nGet information about component templates.", "docId": "indices-component-template", "docTag": "indices", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-component-template.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template", "name": "cluster.get_component_template", "privileges": { "cluster": [ @@ -2472,7 +2472,7 @@ }, "description": "Get cluster-wide settings.\nBy default, it returns only settings that have been explicitly defined.", "docId": "cluster-get-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-get-settings.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings", "name": "cluster.get_settings", "privileges": { "cluster": [ @@ -2514,7 +2514,7 @@ "description": "Get the cluster health status.\n\nYou can also use the API to get the health status of only specified data streams and indices.\nFor data streams, the API retrieves the health status of the stream’s backing indices.\n\nThe cluster health status is: green, yellow or red.\nOn the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated.\nThe index level status is controlled by the worst shard status.\n\nOne of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level.\nThe cluster status is controlled by the worst index status.", "docId": "cluster-health", "docTag": "cluster", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-health.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-health", "name": "cluster.health", "privileges": { "cluster": [ @@ -2562,7 +2562,7 @@ }, "description": "Get cluster info.\nReturns basic information about the cluster.", "docId": "cluster-info", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-info.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-info", "name": "cluster.info", "request": { "name": "Request", @@ -2597,7 +2597,7 @@ }, "description": "Get the pending cluster tasks.\nGet information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect.\n\nNOTE: This API returns a list of any pending updates to the cluster state.\nThese are distinct from the tasks reported by the task management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.\nHowever, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API.", "docId": "cluster-pending", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-pending.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-pending-tasks", "name": "cluster.pending_tasks", "privileges": { "cluster": [ @@ -2634,7 +2634,7 @@ }, "description": "Update voting configuration exclusions.\nUpdate the cluster voting config exclusions by node IDs or node names.\nBy default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks.\nIf you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually.\nThe API adds an entry for each specified node to the cluster’s voting configuration exclusions list.\nIt then waits until the cluster has reconfigured its voting configuration to exclude the specified nodes.\n\nClusters should have no voting configuration exclusions in normal operation.\nOnce the excluded nodes have stopped, clear the voting configuration exclusions with `DELETE /_cluster/voting_config_exclusions`.\nThis API waits for the nodes to be fully removed from the cluster before it returns.\nIf your cluster has voting configuration exclusions for nodes that you no longer intend to remove, use `DELETE /_cluster/voting_config_exclusions?wait_for_removal=false` to clear the voting configuration exclusions without waiting for the nodes to leave the cluster.\n\nA response to `POST /_cluster/voting_config_exclusions` with an HTTP status code of 200 OK guarantees that the node has been removed from the voting configuration and will not be reinstated until the voting configuration exclusions are cleared by calling `DELETE /_cluster/voting_config_exclusions`.\nIf the call to `POST /_cluster/voting_config_exclusions` fails or returns a response with an HTTP status code other than 200 OK then the node may not have been removed from the voting configuration.\nIn that case, you may safely retry the call.\n\nNOTE: Voting exclusions are required only when you remove at least half of the master-eligible nodes from a cluster in a short time period.\nThey are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes.", "docId": "voting-config-exclusions", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/voting-config-exclusions.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-post-voting-config-exclusions", "extDocId": "add-nodes", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/add-elasticsearch-nodes.html", "name": "cluster.post_voting_config_exclusions", @@ -2673,7 +2673,7 @@ "description": "Create or update a component template.\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.\n\n**Applying component templates**\n\nYou cannot directly apply a component template to a data stream or index.\nTo be applied, a component template must be included in an index template's `composed_of` list.", "docId": "indices-component-template", "docTag": "indices", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-component-template.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template", "name": "cluster.put_component_template", "privileges": { "cluster": [ @@ -2717,7 +2717,7 @@ }, "description": "Update the cluster settings.\n\nConfigure and update dynamic settings on a running cluster.\nYou can also configure dynamic settings locally on an unstarted or shut down node in `elasticsearch.yml`.\n\nUpdates made with this API can be persistent, which apply across cluster restarts, or transient, which reset after a cluster restart.\nYou can also reset transient or persistent settings by assigning them a null value.\n\nIf you configure the same setting using multiple methods, Elasticsearch applies the settings in following order of precedence: 1) Transient setting; 2) Persistent setting; 3) `elasticsearch.yml` setting; 4) Default setting value.\nFor example, you can apply a transient setting to override a persistent setting or `elasticsearch.yml` setting.\nHowever, a change to an `elasticsearch.yml` setting will not override a defined transient or persistent setting.\n\nTIP: In Elastic Cloud, use the user settings feature to configure all cluster settings. This method automatically rejects unsafe settings that could break your cluster.\nIf you run Elasticsearch on your own hardware, use this API to configure dynamic cluster settings.\nOnly use `elasticsearch.yml` for static cluster settings and node settings.\nThe API doesn’t require a restart and ensures a setting’s value is the same on all nodes.\n\nWARNING: Transient cluster settings are no longer recommended. Use persistent cluster settings instead.\nIf a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration.", "docId": "cluster-update-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-update-settings.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings", "name": "cluster.put_settings", "request": { "name": "Request", @@ -2752,7 +2752,7 @@ }, "description": "Get remote cluster information.\nGet all of the configured remote cluster information.\nThis API returns connection and endpoint information keyed by the configured remote cluster alias.", "docId": "cluster-remote-info", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-remote-info.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-remote-info", "name": "cluster.remote_info", "request": { "name": "Request", @@ -2788,7 +2788,7 @@ }, "description": "Reroute the cluster.\nManually change the allocation of individual shards in the cluster.\nFor example, a shard can be moved from one node to another explicitly, an allocation can be canceled, and an unassigned shard can be explicitly allocated to a specific node.\n\nIt is important to note that after processing any reroute commands Elasticsearch will perform rebalancing as normal (respecting the values of settings such as `cluster.routing.rebalance.enable`) in order to remain in a balanced state.\nFor example, if the requested allocation includes moving a shard from node1 to node2 then this may cause a shard to be moved from node2 back to node1 to even things out.\n\nThe cluster can be set to disable allocations using the `cluster.routing.allocation.enable` setting.\nIf allocations are disabled then the only allocations that will be performed are explicit ones given using the reroute command, and consequent allocations due to rebalancing.\n\nThe cluster will attempt to allocate a shard a maximum of `index.allocation.max_retries` times in a row (defaults to `5`), before giving up and leaving the shard unallocated.\nThis scenario can be caused by structural problems such as having an analyzer which refers to a stopwords file which doesn’t exist on all nodes.\n\nOnce the problem has been corrected, allocation can be manually retried by calling the reroute API with the `?retry_failed` URI query parameter, which will attempt a single retry round for these shards.", "docId": "cluster-reroute", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-reroute.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-reroute", "name": "cluster.reroute", "request": { "name": "Request", @@ -2827,7 +2827,7 @@ }, "description": "Get the cluster state.\nGet comprehensive information about the state of the cluster.\n\nThe cluster state is an internal data structure which keeps track of a variety of information needed by every node, including the identity and attributes of the other nodes in the cluster; cluster-wide settings; index metadata, including the mapping and settings for each index; the location and status of every shard copy in the cluster.\n\nThe elected master node ensures that every node in the cluster has a copy of the same cluster state.\nThis API lets you retrieve a representation of this internal state for debugging or diagnostic purposes.\nYou may need to consult the Elasticsearch source code to determine the precise meaning of the response.\n\nBy default the API will route requests to the elected master node since this node is the authoritative source of cluster states.\nYou can also retrieve the cluster state held on the node handling the API request by adding the `?local=true` query parameter.\n\nElasticsearch may need to expend significant effort to compute a response to this API in larger clusters, and the response may comprise a very large quantity of data.\nIf you use this API repeatedly, your cluster may become unstable.\n\nWARNING: The response is a representation of an internal data structure.\nIts format is not subject to the same compatibility guarantees as other more stable APIs and may change from version to version.\nDo not query this API using external monitoring tools.\nInstead, obtain the information you require using other more stable cluster APIs.", "docId": "cluster-state", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-state.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-state", "name": "cluster.state", "privileges": { "cluster": [ @@ -2881,7 +2881,7 @@ }, "description": "Get cluster statistics.\nGet basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).", "docId": "cluster-stats", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-stats.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-stats", "name": "cluster.stats", "privileges": { "cluster": [ @@ -2928,7 +2928,7 @@ }, "description": "Check in a connector.\n\nUpdate the `last_seen` field in the connector and set it to the current timestamp.", "docId": "connector-checkin", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/check-in-connector-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-check-in", "name": "connector.check_in", "request": { "name": "Request", @@ -2964,7 +2964,7 @@ }, "description": "Delete a connector.\n\nRemoves a connector and associated sync jobs.\nThis is a destructive action that is not recoverable.\nNOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector.\nThese need to be removed manually.", "docId": "connector-delete", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-connector-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-delete", "name": "connector.delete", "request": { "name": "Request", @@ -3000,7 +3000,7 @@ }, "description": "Get a connector.\n\nGet the details about a connector.", "docId": "connector-get", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-connector-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-get", "name": "connector.get", "request": { "name": "Request", @@ -3037,7 +3037,7 @@ }, "description": "Update the connector last sync stats.\n\nUpdate the fields related to the last sync of a connector.\nThis action is used for analytics and monitoring.", "docId": "connector-last-sync", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-last-sync-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-last-sync", "name": "connector.last_sync", "request": { "name": "Request", @@ -3076,7 +3076,7 @@ }, "description": "Get all connectors.\n\nGet information about all connectors.", "docId": "connector-list", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/list-connector-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-list", "name": "connector.list", "request": { "name": "Request", @@ -3112,7 +3112,7 @@ }, "description": "Create a connector.\n\nConnectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure.\nElastic managed connectors (Native connectors) are a managed service on Elastic Cloud.\nSelf-managed connectors (Connector clients) are self-managed on your infrastructure.", "docId": "connector-post", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/create-connector-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-put", "name": "connector.post", "request": { "name": "Request", @@ -3151,7 +3151,7 @@ }, "description": "Create or update a connector.", "docId": "connector-put", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/create-connector-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-put", "name": "connector.put", "request": { "name": "Request", @@ -3296,7 +3296,7 @@ }, "description": "Cancel a connector sync job.\n\nCancel a connector sync job, which sets the status to cancelling and updates `cancellation_requested_at` to the current time.\nThe connector service is then responsible for setting the status of connector sync jobs to cancelled.", "docId": "connector-sync-job-cancel", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cancel-connector-sync-job-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-cancel", "name": "connector.sync_job_cancel", "request": { "name": "Request", @@ -3328,7 +3328,7 @@ }, "description": "Check in a connector sync job.\nCheck in a connector sync job and set the `last_seen` field to the current time before updating it in the internal index.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.", "docId": "connector-sync-job-checkin", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/check-in-connector-sync-job-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-check-in", "name": "connector.sync_job_check_in", "request": { "name": "Request", @@ -3360,7 +3360,7 @@ }, "description": "Claim a connector sync job.\nThis action updates the job status to `in_progress` and sets the `last_seen` and `started_at` timestamps to the current time.\nAdditionally, it can set the `sync_cursor` property for the sync job.\n\nThis API is not intended for direct connector management by users.\nIt supports the implementation of services that utilize the connector protocol to communicate with Elasticsearch.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.", "docId": "connector-sync-job-claim", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/claim-connector-sync-job-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-claim", "name": "connector.sync_job_claim", "request": { "name": "Request", @@ -3399,7 +3399,7 @@ }, "description": "Delete a connector sync job.\n\nRemove a connector sync job and its associated data.\nThis is a destructive action that is not recoverable.", "docId": "connector-sync-job-delete", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-connector-sync-job-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-delete", "name": "connector.sync_job_delete", "request": { "name": "Request", @@ -3431,7 +3431,7 @@ }, "description": "Set a connector sync job error.\nSet the `error` field for a connector sync job and set its `status` to `error`.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.", "docId": "connector-sync-job-error", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/set-connector-sync-job-error-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-error", "name": "connector.sync_job_error", "request": { "name": "Request", @@ -3470,7 +3470,7 @@ }, "description": "Get a connector sync job.", "docId": "connector-sync-job-get", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-connector-sync-job-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-get", "name": "connector.sync_job_get", "request": { "name": "Request", @@ -3506,7 +3506,7 @@ }, "description": "Get all connector sync jobs.\n\nGet information about all stored connector sync jobs listed by their creation date in ascending order.", "docId": "connector-sync-job-list", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/list-connector-sync-jobs-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-list", "name": "connector.sync_job_list", "request": { "name": "Request", @@ -3542,7 +3542,7 @@ }, "description": "Create a connector sync job.\n\nCreate a connector sync job document in the internal index and initialize its counters and timestamps with default values.", "docId": "connector-sync-job-post", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/create-connector-sync-job-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-post", "name": "connector.sync_job_post", "request": { "name": "Request", @@ -3577,7 +3577,7 @@ }, "description": "Set the connector sync job stats.\nStats include: `deleted_document_count`, `indexed_document_count`, `indexed_document_volume`, and `total_document_count`.\nYou can also update `last_seen`.\nThis API is mainly used by the connector service for updating sync job information.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.", "docId": "connector-sync-job-stats", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/set-connector-sync-job-stats-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-update-stats", "name": "connector.sync_job_update_stats", "request": { "name": "Request", @@ -3616,7 +3616,7 @@ }, "description": "Activate the connector draft filter.\n\nActivates the valid draft filtering for a connector.", "docId": "connector-update-filtering", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-filtering-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering", "name": "connector.update_active_filtering", "request": { "name": "Request", @@ -3655,7 +3655,7 @@ }, "description": "Update the connector API key ID.\n\nUpdate the `api_key_id` and `api_key_secret_id` fields of a connector.\nYou can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored.\nThe connector secret ID is required only for Elastic managed (native) connectors.\nSelf-managed connectors (connector clients) do not use this field.", "docId": "connector-update-api-key-id", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-api-key-id-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-api-key-id", "name": "connector.update_api_key_id", "request": { "name": "Request", @@ -3694,7 +3694,7 @@ }, "description": "Update the connector configuration.\n\nUpdate the configuration field in the connector document.", "docId": "connector-configuration", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-configuration-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-configuration", "name": "connector.update_configuration", "request": { "name": "Request", @@ -3733,7 +3733,7 @@ }, "description": "Update the connector error field.\n\nSet the error field for the connector.\nIf the error provided in the request body is non-null, the connector’s status is updated to error.\nOtherwise, if the error is reset to null, the connector status is updated to connected.", "docId": "connector-update-error", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-error-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-error", "name": "connector.update_error", "request": { "name": "Request", @@ -3768,7 +3768,7 @@ }, "description": "Update the connector features.\nUpdate the connector features in the connector document.\nThis API can be used to control the following aspects of a connector:\n\n* document-level security\n* incremental syncs\n* advanced sync rules\n* basic sync rules\n\nNormally, the running connector service automatically manages these features.\nHowever, you can use this API to override the default behavior.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors.", "docId": "connector-features", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-features-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-features", "name": "connector.update_features", "request": { "name": "Request", @@ -3807,7 +3807,7 @@ }, "description": "Update the connector filtering.\n\nUpdate the draft filtering configuration of a connector and marks the draft validation state as edited.\nThe filtering draft is activated once validated by the running Elastic connector service.\nThe filtering property is used to configure sync rules (both basic and advanced) for a connector.", "docId": "connector-update-filtering", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-filtering-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering", "name": "connector.update_filtering", "request": { "name": "Request", @@ -3885,7 +3885,7 @@ }, "description": "Update the connector index name.\n\nUpdate the `index_name` field of a connector, specifying the index where the data ingested by the connector is stored.", "docId": "connector-update-index-name", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-index-name-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-index-name", "name": "connector.update_index_name", "request": { "name": "Request", @@ -3924,7 +3924,7 @@ }, "description": "Update the connector name and description.", "docId": "connector-update-name", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-name-description-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-name", "name": "connector.update_name", "request": { "name": "Request", @@ -4002,7 +4002,7 @@ }, "description": "Update the connector pipeline.\n\nWhen you create a new connector, the configuration of an ingest pipeline is populated with default settings.", "docId": "connector-update-pipeline", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-pipeline-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-pipeline", "name": "connector.update_pipeline", "request": { "name": "Request", @@ -4041,7 +4041,7 @@ }, "description": "Update the connector scheduling.", "docId": "connector-update-scheduling", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-scheduling-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-scheduling", "name": "connector.update_scheduling", "request": { "name": "Request", @@ -4080,7 +4080,7 @@ }, "description": "Update the connector service type.", "docId": "connector-update-service-type", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-service-type-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-service-type", "name": "connector.update_service_type", "request": { "name": "Request", @@ -4119,7 +4119,7 @@ }, "description": "Update the connector status.", "docId": "connector-update-status", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-status-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-status", "name": "connector.update_status", "request": { "name": "Request", @@ -4158,7 +4158,7 @@ "description": "Count search results.\nGet the number of documents matching a query.\n\nThe query can be provided either by using a simple query string as a parameter, or by defining Query DSL within the request body.\nThe query is optional. When no query is provided, the API uses `match_all` to count all the documents.\n\nThe count API supports multi-target syntax. You can run a single count API search across multiple data streams and indices.\n\nThe operation is broadcast across all shards.\nFor each shard ID group, a replica is chosen and the search is run against it.\nThis means that replicas increase the scalability of the count.", "docId": "search-count", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-count.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-count", "name": "count", "privileges": { "index": [ @@ -4211,7 +4211,7 @@ "description": "Create a new document in the index.\n\nYou can index a new JSON document with the `//_doc/` or `//_create/<_id>` APIs\nUsing `_create` guarantees that the document is indexed only if it does not already exist.\nIt returns a 409 response when a document with a same ID already exists in the index.\nTo update an existing document, you must use the `//_doc/` API.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To add a document using the `PUT //_create/<_id>` or `POST //_create/<_id>` request formats, you must have the `create_doc`, `create`, `index`, or `write` index privilege.\n* To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\n**Automatically create data streams and indices**\n\nIf the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.\n\nIf the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.\n\nNOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.\n\nIf no mapping exists, the index operation creates a dynamic mapping.\nBy default, new fields and objects are automatically added to the mapping if needed.\n\nAutomatic index creation is controlled by the `action.auto_create_index` setting.\nIf it is `true`, any index can be created automatically.\nYou can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely.\nSpecify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked.\nWhen a list is specified, the default behaviour is to disallow.\n\nNOTE: The `action.auto_create_index` setting affects the automatic creation of indices only.\nIt does not affect the creation of data streams.\n\n**Routing**\n\nBy default, shard placement — or routing — is controlled by using a hash of the document's ID value.\nFor more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.\n\nWhen setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself.\nThis does come at the (very minimal) cost of an additional document parsing pass.\nIf the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Distributed**\n\nThe index operation is directed to the primary shard based on its route and performed on the actual node containing this shard.\nAfter the primary shard completes the operation, if needed, the update is distributed to applicable replicas.\n\n**Active shards**\n\nTo improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation.\nIf the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs.\nBy default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`).\nThis default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`.\nTo alter this behavior per operation, use the `wait_for_active_shards request` parameter.\n\nValid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1).\nSpecifying a negative value or a number greater than the number of shard copies will throw an error.\n\nFor example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes).\nIf you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding.\nThis means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data.\nIf `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding.\nThis requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard.\nHowever, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index.\nThe operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.\n\nIt is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts.\nAfter the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary.\nThe `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed.", "docId": "docs-index", "docTag": "document", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-index_.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create", "extDocId": "data-streams", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams.html", "name": "create", @@ -4255,7 +4255,7 @@ "description": "Delete a dangling index.\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.", "docId": "dangling-index-delete", "docTag": "indices", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/dangling-index-delete.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-delete-dangling-index", "name": "dangling_indices.delete_dangling_index", "privileges": { "cluster": [ @@ -4293,7 +4293,7 @@ "description": "Import a dangling index.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.", "docId": "dangling-index-import", "docTag": "indices", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/dangling-index-import.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-import-dangling-index", "name": "dangling_indices.import_dangling_index", "privileges": { "cluster": [ @@ -4331,7 +4331,7 @@ "description": "Get the dangling indices.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.\n\nUse this API to list dangling indices, which you can then import or delete.", "docId": "dangling-indices-list", "docTag": "indices", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/dangling-indices-list.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-list-dangling-indices", "name": "dangling_indices.list_dangling_indices", "privileges": { "cluster": [ @@ -4372,7 +4372,7 @@ "description": "Delete a document.\n\nRemove a JSON document from the specified index.\n\nNOTE: You cannot send deletion requests directly to a data stream.\nTo delete a document in a data stream, you must target the backing index containing the document.\n\n**Optimistic concurrency control**\n\nDelete operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters.\nIf a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.\n\n**Versioning**\n\nEach document indexed is versioned.\nWhen deleting a document, the version can be specified to make sure the relevant document you are trying to delete is actually being deleted and it has not changed in the meantime.\nEvery write operation run on a document, deletes included, causes its version to be incremented.\nThe version number of a deleted document remains available for a short time after deletion to allow for control of concurrent operations.\nThe length of time for which a deleted document's version remains available is determined by the `index.gc_deletes` index setting.\n\n**Routing**\n\nIf routing is used during indexing, the routing value also needs to be specified to delete a document.\n\nIf the `_routing` mapping is set to `required` and no routing value is specified, the delete API throws a `RoutingMissingException` and rejects the request.\n\nFor example:\n\n```\nDELETE /my-index-000001/_doc/1?routing=shard-1\n```\n\nThis request deletes the document with ID 1, but it is routed based on the user.\nThe document is not deleted if the correct routing is not specified.\n\n**Distributed**\n\nThe delete operation gets hashed into a specific shard ID.\nIt then gets redirected into the primary shard within that ID group and replicated (if needed) to shard replicas within that ID group.", "docId": "docs-delete", "docTag": "document", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-delete.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete", "name": "delete", "privileges": { "index": [ @@ -4414,7 +4414,7 @@ "description": "Delete documents.\n\nDeletes documents that match the specified query.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or alias:\n\n* `read`\n* `delete` or `write`\n\nYou can specify the query criteria in the request URI or the request body using the same syntax as the search API.\nWhen you submit a delete by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and deletes matching documents using internal versioning.\nIf a document changes between the time that the snapshot is taken and the delete operation is processed, it results in a version conflict and the delete operation fails.\n\nNOTE: Documents with a version equal to 0 cannot be deleted using delete by query because internal versioning does not support 0 as a valid version number.\n\nWhile processing a delete by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents to delete.\nA bulk delete request is performed for each batch of matching documents.\nIf a search or bulk request is rejected, the requests are retried up to 10 times, with exponential back off.\nIf the maximum retry limit is reached, processing halts and all failed requests are returned in the response.\nAny delete requests that completed successfully still stick, they are not rolled back.\n\nYou can opt to count version conflicts instead of halting and returning by setting `conflicts` to `proceed`.\nNote that if you opt to count version conflicts the operation could attempt to delete more documents from the source than `max_docs` until it has successfully deleted `max_docs documents`, or it has gone through every document in the source query.\n\n**Throttling delete requests**\n\nTo control the rate at which delete by query issues batches of delete operations, you can set `requests_per_second` to any positive decimal number.\nThis pads each batch with a wait time to throttle the rate.\nSet `requests_per_second` to `-1` to disable throttling.\n\nThrottling uses a wait time between batches so that the internal scroll requests can be given a timeout that takes the request padding into account.\nThe padding time is the difference between the batch size divided by the `requests_per_second` and the time spent writing.\nBy default the batch size is `1000`, so if `requests_per_second` is set to `500`:\n\n```\ntarget_time = 1000 / 500 per second = 2 seconds\nwait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds\n```\n\nSince the batch is issued as a single `_bulk` request, large batch sizes cause Elasticsearch to create many requests and wait before starting the next set.\nThis is \"bursty\" instead of \"smooth\".\n\n**Slicing**\n\nDelete by query supports sliced scroll to parallelize the delete process.\nThis can improve efficiency and provide a convenient way to break the request down into smaller parts.\n\nSetting `slices` to `auto` lets Elasticsearch choose the number of slices to use.\nThis setting will use one slice per shard, up to a certain limit.\nIf there are multiple source data streams or indices, it will choose the number of slices based on the index or backing index with the smallest number of shards.\nAdding slices to the delete by query operation creates sub-requests which means it has some quirks:\n\n* You can see these requests in the tasks APIs. These sub-requests are \"child\" tasks of the task for the request with slices.\n* Fetching the status of the task for the request with slices only contains the status of completed slices.\n* These sub-requests are individually addressable for things like cancellation and rethrottling.\n* Rethrottling the request with `slices` will rethrottle the unfinished sub-request proportionally.\n* Canceling the request with `slices` will cancel each sub-request.\n* Due to the nature of `slices` each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution.\n* Parameters like `requests_per_second` and `max_docs` on a request with `slices` are distributed proportionally to each sub-request. Combine that with the earlier point about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being deleted.\n* Each sub-request gets a slightly different snapshot of the source data stream or index though these are all taken at approximately the same time.\n\nIf you're slicing manually or otherwise tuning automatic slicing, keep in mind that:\n\n* Query performance is most efficient when the number of slices is equal to the number of shards in the index or backing index. If that number is large (for example, 500), choose a lower number as too many `slices` hurts performance. Setting `slices` higher than the number of shards generally does not improve efficiency and adds overhead.\n* Delete performance scales linearly across available resources with the number of slices.\n\nWhether query or delete performance dominates the runtime depends on the documents being reindexed and cluster resources.\n\n**Cancel a delete by query operation**\n\nAny delete by query can be canceled using the task cancel API. For example:\n\n```\nPOST _tasks/r1A2WoRbTwKZ516z6NEs5A:36619/_cancel\n```\n\nThe task ID can be found by using the get tasks API.\n\nCancellation should happen quickly but might take a few seconds.\nThe get task status API will continue to list the delete by query task until this task checks that it has been cancelled and terminates itself.", "docId": "docs-delete-by-query", "docTag": "document", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-delete-by-query.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-by-query", "name": "delete_by_query", "privileges": { "index": [ @@ -4496,7 +4496,7 @@ "description": "Delete a script or search template.\nDeletes a stored script or search template.", "docId": "script-delete", "docTag": "script", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-stored-script-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-script", "name": "delete_script", "privileges": { "cluster": [ @@ -4537,7 +4537,7 @@ }, "description": "Delete an enrich policy.\nDeletes an existing enrich policy and its enrich index.", "docId": "delete-enrich-policy-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-enrich-policy-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-delete-policy", "name": "enrich.delete_policy", "request": { "name": "Request", @@ -4573,7 +4573,7 @@ }, "description": "Run an enrich policy.\nCreate the enrich index for an existing enrich policy.", "docId": "execute-enrich-policy-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/execute-enrich-policy-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-execute-policy", "name": "enrich.execute_policy", "request": { "name": "Request", @@ -4609,7 +4609,7 @@ }, "description": "Get an enrich policy.\nReturns information about an enrich policy.", "docId": "get-enrich-policy-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-enrich-policy-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-get-policy", "name": "enrich.get_policy", "request": { "name": "Request", @@ -4651,7 +4651,7 @@ }, "description": "Create an enrich policy.\nCreates an enrich policy.", "docId": "put-enrich-policy-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-enrich-policy-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-put-policy", "name": "enrich.put_policy", "request": { "name": "Request", @@ -4690,7 +4690,7 @@ }, "description": "Get enrich stats.\nReturns enrich coordinator statistics and information about enrich policies that are currently executing.", "docId": "enrich-stats-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/enrich-stats-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-stats", "name": "enrich.stats", "request": { "name": "Request", @@ -4762,7 +4762,7 @@ }, "description": "Get async EQL search results.\nGet the current status and available results for an async EQL search or a stored synchronous EQL search.", "docId": "eql-async-search-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-eql-search-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-get", "name": "eql.get", "request": { "name": "Request", @@ -4798,7 +4798,7 @@ }, "description": "Get the async EQL status.\nGet the current status for an async EQL search or a stored synchronous EQL search without returning results.", "docId": "eql-async-search-status-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-eql-status-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-get-status", "name": "eql.get_status", "request": { "name": "Request", @@ -4834,7 +4834,7 @@ }, "description": "Get EQL search results.\nReturns search results for an Event Query Language (EQL) query.\nEQL assumes each document in a data stream or index corresponds to an event.", "docId": "eql-search-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-search-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-search", "extDocId": "eql", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql.html", "name": "eql.search", @@ -4873,7 +4873,7 @@ }, "description": "Run an async ES|QL query.\nAsynchronously run an ES|QL (Elasticsearch query language) query, monitor its progress, and retrieve results when they become available.\n\nThe API accepts the same parameters and request body as the synchronous query API, along with additional async related properties.", "docId": "esql-async-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-async-query-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query", "extDocId": "esql", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql.html", "name": "esql.async_query", @@ -4916,7 +4916,7 @@ }, "description": "Delete an async ES|QL query.\nIf the query is still running, it is cancelled.\nOtherwise, the stored results are deleted.\n\nIf the Elasticsearch security features are enabled, only the following users can use this API to delete a query:\n\n* The authenticated user that submitted the original query request\n* Users with the `cancel_task` cluster privilege", "docId": "esql-async-query-delete", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-async-query-delete-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query-delete", "extDocId": "esql", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql.html", "name": "esql.async_query_delete", @@ -4951,7 +4951,7 @@ }, "description": "Get async ES|QL query results.\nGet the current status and available results or stored results for an ES|QL asynchronous query.\nIf the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can retrieve the results using this API.", "docId": "esql-async-query-get", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-async-query-get-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query-get", "extDocId": "esql", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql.html", "name": "esql.async_query_get", @@ -5061,7 +5061,7 @@ "description": "Check a document.\n\nVerify that a document exists.\nFor example, check to see if a document with the `_id` 0 exists:\n\n```\nHEAD my-index-000001/_doc/0\n```\n\nIf the document exists, the API returns a status code of `200 - OK`.\nIf the document doesn’t exist, the API returns `404 - Not Found`.\n\n**Versioning support**\n\nYou can use the `version` parameter to check the document only if its current version is equal to the specified one.\n\nInternally, Elasticsearch has marked the old document as deleted and added an entirely new document.\nThe old version of the document doesn't disappear immediately, although you won't be able to access it.\nElasticsearch cleans up deleted documents in the background as you continue to index more data.", "docId": "docs-get", "docTag": "document", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get", "name": "exists", "request": { "name": "Request", @@ -5098,7 +5098,7 @@ "description": "Check for a document source.\n\nCheck whether a document source exists in an index.\nFor example:\n\n```\nHEAD my-index-000001/_source/1\n```\n\nA document's source is not available if it is disabled in the mapping.", "docId": "docs-get", "docTag": "document", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get", "extDocId": "mapping-source-field", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-source-field.html", "name": "exists_source", @@ -5141,7 +5141,7 @@ "description": "Explain a document match result.\nGet information about why a specific document matches, or doesn't match, a query.\nIt computes a score explanation for a query and a specific document.", "docId": "search-explain", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-explain.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-explain", "name": "explain", "privileges": { "index": [ @@ -5182,7 +5182,7 @@ }, "description": "Get the features.\nGet a list of features that can be included in snapshots using the `feature_states` field when creating a snapshot.\nYou can use this API to determine which feature states to include when taking a snapshot.\nBy default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not.\n\nA feature state includes one or more system indices necessary for a given feature to function.\nIn order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together.\n\nThe features listed by this API are a combination of built-in features and features defined by plugins.\nIn order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node.", "docId": "get-features-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-features-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-features-get-features", "extDocId": "snapshot-create", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/snapshots-take-snapshot.html", "name": "features.get_features", @@ -5220,7 +5220,7 @@ }, "description": "Reset the features.\nClear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices.\n\nWARNING: Intended for development and testing use only. Do not reset features on a production cluster.\n\nReturn a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features.\nThis deletes all state information stored in system indices.\n\nThe response code is HTTP 200 if the state is successfully reset for all features.\nIt is HTTP 500 if the reset operation failed for any feature.\n\nNote that select features might provide a way to reset particular system indices.\nUsing this API resets all features, both those that are built-in and implemented as plugins.\n\nTo list the features that will be affected, use the get features API.\n\nIMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes.", "docId": "features-reset", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/reset-features-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-features-reset-features", "name": "features.reset_features", "request": { "name": "Request", @@ -5257,7 +5257,7 @@ "description": "Get the field capabilities.\n\nGet information about the capabilities of fields among multiple indices.\n\nFor data streams, the API returns field capabilities among the stream’s backing indices.\nIt returns runtime fields like any other field.\nFor example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family.", "docId": "search-field-caps", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-field-caps.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-field-caps", "name": "field_caps", "privileges": { "index": [ @@ -5360,7 +5360,7 @@ }, "description": "Get global checkpoints.\n\nGet the current global checkpoints for an index.\nThis API is designed for internal use by the Fleet server project.", "docId": "get-global-checkpoints", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-global-checkpoints.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-fleet", "name": "fleet.global_checkpoints", "request": { "name": "Request", @@ -5399,7 +5399,7 @@ }, "description": "Run multiple Fleet searches.\nRun several Fleet searches with a single API request.\nThe API follows the same structure as the multi search API.\nHowever, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter.", "docId": "fleet-multi-search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/fleet-multi-search.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-fleet-msearch", "name": "fleet.msearch", "privileges": { "index": [ @@ -5476,7 +5476,7 @@ }, "description": "Run a Fleet search.\nThe purpose of the Fleet search API is to provide an API where the search will be run only\nafter the provided checkpoint has been processed and is visible for searches inside of Elasticsearch.", "docId": "fleet-search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/fleet-search.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-fleet-search", "name": "fleet.search", "privileges": { "index": [ @@ -5521,7 +5521,7 @@ "description": "Get a document by its ID.\n\nGet a document and its source or stored fields from an index.\n\nBy default, this API is realtime and is not affected by the refresh rate of the index (when data will become visible for search).\nIn the case where stored fields are requested with the `stored_fields` parameter and the document has been updated but is not yet refreshed, the API will have to parse and analyze the source to extract the stored fields.\nTo turn off realtime behavior, set the `realtime` parameter to false.\n\n**Source filtering**\n\nBy default, the API returns the contents of the `_source` field unless you have used the `stored_fields` parameter or the `_source` field is turned off.\nYou can turn off `_source` retrieval by using the `_source` parameter:\n\n```\nGET my-index-000001/_doc/0?_source=false\n```\n\nIf you only need one or two fields from the `_source`, use the `_source_includes` or `_source_excludes` parameters to include or filter out particular fields.\nThis can be helpful with large documents where partial retrieval can save on network overhead\nBoth parameters take a comma separated list of fields or wildcard expressions.\nFor example:\n\n```\nGET my-index-000001/_doc/0?_source_includes=*.id&_source_excludes=entities\n```\n\nIf you only want to specify includes, you can use a shorter notation:\n\n```\nGET my-index-000001/_doc/0?_source=*.id\n```\n\n**Routing**\n\nIf routing is used during indexing, the routing value also needs to be specified to retrieve a document.\nFor example:\n\n```\nGET my-index-000001/_doc/2?routing=user1\n```\n\nThis request gets the document with ID 2, but it is routed based on the user.\nThe document is not fetched if the correct routing is not specified.\n\n**Distributed**\n\nThe GET operation is hashed into a specific shard ID.\nIt is then redirected to one of the replicas within that shard ID and returns the result.\nThe replicas are the primary shard and its replicas within that shard ID group.\nThis means that the more replicas you have, the better your GET scaling will be.\n\n**Versioning support**\n\nYou can use the `version` parameter to retrieve the document only if its current version is equal to the specified one.\n\nInternally, Elasticsearch has marked the old document as deleted and added an entirely new document.\nThe old version of the document doesn't disappear immediately, although you won't be able to access it.\nElasticsearch cleans up deleted documents in the background as you continue to index more data.", "docId": "docs-get", "docTag": "document", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get", "name": "get", "privileges": { "index": [ @@ -5562,7 +5562,7 @@ "description": "Get a script or search template.\nRetrieves a stored script or search template.", "docId": "script-get", "docTag": "script", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-stored-script-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get-script", "name": "get_script", "privileges": { "cluster": [ @@ -5599,7 +5599,7 @@ "description": "Get script contexts.\n\nGet a list of supported script contexts and their methods.", "docId": "script-contexts", "docTag": "script", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-script-contexts-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get-script-context", "name": "get_script_context", "privileges": { "cluster": [ @@ -5636,7 +5636,7 @@ "description": "Get script languages.\n\nGet a list of available script types, languages, and contexts.", "docId": "script-languages", "docTag": "script", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-script-languages-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get-script-languages", "name": "get_script_languages", "privileges": { "cluster": [ @@ -5677,7 +5677,7 @@ "description": "Get a document's source.\n\nGet the source of a document.\nFor example:\n\n```\nGET my-index-000001/_source/1\n```\n\nYou can use the source filtering parameters to control which parts of the `_source` are returned:\n\n```\nGET my-index-000001/_source/1/?_source_includes=*.id&_source_excludes=entities\n```", "docId": "docs-get", "docTag": "document", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get", "extDocId": "mapping-source-field", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-source-field.html", "name": "get_source", @@ -5719,7 +5719,7 @@ }, "description": "Explore graph analytics.\nExtract and summarize information about the documents and terms in an Elasticsearch data stream or index.\nThe easiest way to understand the behavior of this API is to use the Graph UI to explore connections.\nAn initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph.\nSubsequent requests enable you to spider out from one more vertices of interest.\nYou can exclude vertices that have already been returned.", "docId": "graph-explore-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/graph-explore-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-graph", "extDocId": "graph", "extDocUrl": "https://www.elastic.co/guide/en/kibana/{branch}/xpack-graph.html", "name": "graph.explore", @@ -5761,7 +5761,7 @@ }, "description": "Get the cluster health.\nGet a report with the health status of an Elasticsearch cluster.\nThe report contains a list of indicators that compose Elasticsearch functionality.\n\nEach indicator has a health status of: green, unknown, yellow or red.\nThe indicator will provide an explanation and metadata describing the reason for its current health status.\n\nThe cluster’s status is controlled by the worst indicator status.\n\nIn the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue.\nEach impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system.\n\nSome health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system.\nThe root cause and remediation steps are encapsulated in a diagnosis.\nA diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem.\n\nNOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently.\nWhen setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic.", "docId": "health-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/health-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-health-report", "name": "health_report", "request": { "name": "Request", @@ -5799,7 +5799,7 @@ }, "description": "Delete a lifecycle policy.\nYou cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error.", "docId": "ilm-delete-lifecycle", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-delete-lifecycle.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-delete-lifecycle", "name": "ilm.delete_lifecycle", "privileges": { "cluster": [ @@ -5836,7 +5836,7 @@ }, "description": "Explain the lifecycle state.\nGet the current lifecycle status for one or more indices.\nFor data streams, the API retrieves the current lifecycle status for the stream's backing indices.\n\nThe response indicates when the index entered each lifecycle state, provides the definition of the running phase, and information about any failures.", "docId": "ilm-explain-lifecycle", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-explain-lifecycle.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-explain-lifecycle", "name": "ilm.explain_lifecycle", "privileges": { "index": [ @@ -5874,7 +5874,7 @@ }, "description": "Get lifecycle policies.", "docId": "ilm-get-lifecycle", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-get-lifecycle.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-get-lifecycle", "name": "ilm.get_lifecycle", "privileges": { "cluster": [ @@ -5918,7 +5918,7 @@ }, "description": "Get the ILM status.\n\nGet the current index lifecycle management status.", "docId": "ilm-get-status", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-get-status.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-get-status", "name": "ilm.get_status", "privileges": { "cluster": [ @@ -5955,7 +5955,7 @@ }, "description": "Migrate to data tiers routing.\nSwitch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers.\nOptionally, delete one legacy index template.\nUsing node roles enables ILM to automatically move the indices between data tiers.\n\nMigrating away from custom node attributes routing can be manually performed.\nThis API provides an automated way of performing three out of the four manual steps listed in the migration guide:\n\n1. Stop setting the custom hot attribute on new indices.\n1. Remove custom allocation settings from existing ILM policies.\n1. Replace custom allocation settings from existing indices with the corresponding tier preference.\n\nILM must be stopped before performing the migration.\nUse the stop ILM and get ILM status APIs to wait until the reported operation mode is `STOPPED`.", "docId": "ilm-migrate-to-data-tiers", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-migrate-to-data-tiers.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-migrate-to-data-tiers", "extDocId": "migrate-index-allocation-filters", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/migrate-index-allocation-filters.html", "name": "ilm.migrate_to_data_tiers", @@ -5992,7 +5992,7 @@ }, "description": "Move to a lifecycle step.\nManually move an index into a specific step in the lifecycle policy and run that step.\n\nWARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API.\n\nYou must specify both the current step and the step to be executed in the body of the request.\nThe request will fail if the current step does not match the step currently running for the index\nThis is to prevent the index from being moved from an unexpected step into the next step.\n\nWhen specifying the target (`next_step`) to which the index will be moved, either the name or both the action and name fields are optional.\nIf only the phase is specified, the index will move to the first step of the first action in the target phase.\nIf the phase and action are specified, the index will move to the first step of the specified action in the specified phase.\nOnly actions specified in the ILM policy are considered valid.\nAn index cannot move to a step that is not part of its policy.", "docId": "ilm-move-to-step", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-move-to-step.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-move-to-step", "name": "ilm.move_to_step", "privileges": { "index": [ @@ -6032,7 +6032,7 @@ }, "description": "Create or update a lifecycle policy.\nIf the specified policy exists, it is replaced and the policy version is incremented.\n\nNOTE: Only the latest version of the policy is stored, you cannot revert to previous versions.", "docId": "ilm-put-lifecycle", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-put-lifecycle.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-put-lifecycle", "extDocId": "ilm-index-lifecycle", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-index-lifecycle.html", "name": "ilm.put_lifecycle", @@ -6077,7 +6077,7 @@ }, "description": "Remove policies from an index.\nRemove the assigned lifecycle policies from an index or a data stream's backing indices.\nIt also stops managing the indices.", "docId": "ilm-remove-policy", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-remove-policy.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-remove-policy", "name": "ilm.remove_policy", "privileges": { "index": [ @@ -6114,7 +6114,7 @@ }, "description": "Retry a policy.\nRetry running the lifecycle policy for an index that is in the ERROR step.\nThe API sets the policy back to the step where the error occurred and runs the step.\nUse the explain lifecycle state API to determine whether an index is in the ERROR step.", "docId": "ilm-retry-policy", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-retry-policy.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-retry", "name": "ilm.retry", "privileges": { "index": [ @@ -6151,7 +6151,7 @@ }, "description": "Start the ILM plugin.\nStart the index lifecycle management plugin if it is currently stopped.\nILM is started automatically when the cluster is formed.\nRestarting ILM is necessary only when it has been stopped using the stop ILM API.", "docId": "ilm-start", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-start.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-start", "name": "ilm.start", "privileges": { "cluster": [ @@ -6188,7 +6188,7 @@ }, "description": "Stop the ILM plugin.\nHalt all lifecycle management operations and stop the index lifecycle management plugin.\nThis is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices.\n\nThe API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped.\nUse the get ILM status API to check whether ILM is running.", "docId": "ilm-stop", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ilm-stop.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-stop", "name": "ilm.stop", "privileges": { "cluster": [ @@ -6229,7 +6229,7 @@ "description": "Create or update a document in an index.\n\nAdd a JSON document to the specified data stream or index and make it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.\n\nNOTE: You cannot use this API to send update requests for existing documents in a data stream.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To add or overwrite a document using the `PUT //_doc/<_id>` request format, you must have the `create`, `index`, or `write` index privilege.\n* To add a document using the `POST //_doc/` request format, you must have the `create_doc`, `create`, `index`, or `write` index privilege.\n* To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nNOTE: Replica shards might not all be started when an indexing operation returns successfully.\nBy default, only the primary is required. Set `wait_for_active_shards` to change this default behavior.\n\n**Automatically create data streams and indices**\n\nIf the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.\n\nIf the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.\n\nNOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.\n\nIf no mapping exists, the index operation creates a dynamic mapping.\nBy default, new fields and objects are automatically added to the mapping if needed.\n\nAutomatic index creation is controlled by the `action.auto_create_index` setting.\nIf it is `true`, any index can be created automatically.\nYou can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely.\nSpecify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked.\nWhen a list is specified, the default behaviour is to disallow.\n\nNOTE: The `action.auto_create_index` setting affects the automatic creation of indices only.\nIt does not affect the creation of data streams.\n\n**Optimistic concurrency control**\n\nIndex operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters.\nIf a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.\n\n**Routing**\n\nBy default, shard placement — or routing — is controlled by using a hash of the document's ID value.\nFor more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.\n\nWhen setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself.\nThis does come at the (very minimal) cost of an additional document parsing pass.\nIf the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Distributed**\n\nThe index operation is directed to the primary shard based on its route and performed on the actual node containing this shard.\nAfter the primary shard completes the operation, if needed, the update is distributed to applicable replicas.\n\n**Active shards**\n\nTo improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation.\nIf the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs.\nBy default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`).\nThis default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`.\nTo alter this behavior per operation, use the `wait_for_active_shards request` parameter.\n\nValid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1).\nSpecifying a negative value or a number greater than the number of shard copies will throw an error.\n\nFor example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes).\nIf you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding.\nThis means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data.\nIf `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding.\nThis requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard.\nHowever, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index.\nThe operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.\n\nIt is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts.\nAfter the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary.\nThe `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed.\n\n**No operation (noop) updates**\n\nWhen updating a document by using this API, a new version of the document is always created even if the document hasn't changed.\nIf this isn't acceptable use the `_update` API with `detect_noop` set to `true`.\nThe `detect_noop` option isn't available on this API because it doesn’t fetch the old source and isn't able to compare it against the new source.\n\nThere isn't a definitive rule for when noop updates aren't acceptable.\nIt's a combination of lots of factors like how frequently your data source sends updates that are actually noops and how many queries per second Elasticsearch runs on the shard receiving the updates.\n\n**Versioning**\n\nEach indexed document is given a version number.\nBy default, internal versioning is used that starts at 1 and increments with each update, deletes included.\nOptionally, the version number can be set to an external value (for example, if maintained in a database).\nTo enable this functionality, `version_type` should be set to `external`.\nThe value provided must be a numeric, long value greater than or equal to 0, and less than around `9.2e+18`.\n\nNOTE: Versioning is completely real time, and is not affected by the near real time aspects of search operations.\nIf no version is provided, the operation runs without any version checks.\n\nWhen using the external version type, the system checks to see if the version number passed to the index request is greater than the version of the currently stored document.\nIf true, the document will be indexed and the new version number used.\nIf the value provided is less than or equal to the stored document's version number, a version conflict will occur and the index operation will fail. For example:\n\n```\nPUT my-index-000001/_doc/1?version=2&version_type=external\n{\n \"user\": {\n \"id\": \"elkbee\"\n }\n}\n\nIn this example, the operation will succeed since the supplied version of 2 is higher than the current document version of 1.\nIf the document was already updated and its version was set to 2 or higher, the indexing command will fail and result in a conflict (409 HTTP status code).\n\nA nice side effect is that there is no need to maintain strict ordering of async indexing operations run as a result of changes to a source database, as long as version numbers from the source database are used.\nEven the simple case of updating the Elasticsearch index using data from a database is simplified if external versioning is used, as only the latest version will be used if the index operations arrive out of order.", "docId": "docs-index", "docTag": "document", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-index_.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create", "extDocId": "data-streams", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams.html", "name": "index", @@ -6317,7 +6317,7 @@ }, "description": "Get tokens from text analysis.\nThe analyze API performs analysis on a text string and returns the resulting tokens.\n\nGenerating excessive amount of tokens may cause a node to run out of memory.\nThe `index.analyze.max_token_count` setting enables you to limit the number of tokens that can be produced.\nIf more than this limit of tokens gets generated, an error occurs.\nThe `_analyze` endpoint without a specified index will always use `10000` as its limit.", "docId": "indices-analyze", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-analyze.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-analyze", "extDocId": "analysis", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/analysis.html", "name": "indices.analyze", @@ -6410,7 +6410,7 @@ }, "description": "Clear the cache.\nClear the cache of one or more indices.\nFor data streams, the API clears the caches of the stream's backing indices.\n\nBy default, the clear cache API clears all caches.\nTo clear only specific caches, use the `fielddata`, `query`, or `request` parameters.\nTo clear the cache only of specific fields, use the `fields` parameter.", "docId": "indices-clearcache", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-clearcache.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-clear-cache", "name": "indices.clear_cache", "privileges": { "index": [ @@ -6453,7 +6453,7 @@ }, "description": "Clone an index.\nClone an existing index into a new index.\nEach original primary shard is cloned into a new primary shard in the new index.\n\nIMPORTANT: Elasticsearch does not apply index templates to the resulting index.\nThe API also does not copy index metadata from the original index.\nIndex metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information.\nFor example, if you clone a CCR follower index, the resulting clone will not be a follower index.\n\nThe clone API copies most index settings from the source index to the resulting index, with the exception of `index.number_of_replicas` and `index.auto_expand_replicas`.\nTo set the number of replicas in the resulting index, configure these settings in the clone request.\n\nCloning works as follows:\n\n* First, it creates a new target index with the same definition as the source index.\n* Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process.\n* Finally, it recovers the target index as though it were a closed index which had just been re-opened.\n\nIMPORTANT: Indices can only be cloned if they meet the following requirements:\n\n* The index must be marked as read-only and have a cluster health status of green.\n* The target index must not exist.\n* The source index must have the same number of primary shards as the target index.\n* The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index.\n\nThe current write index on a data stream cannot be cloned.\nIn order to clone the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be cloned.\n\nNOTE: Mappings cannot be specified in the `_clone` request. The mappings of the source index will be used for the target index.\n\n**Monitor the cloning process**\n\nThe cloning process can be monitored with the cat recovery API or the cluster health API can be used to wait until all primary shards have been allocated by setting the `wait_for_status` parameter to `yellow`.\n\nThe `_clone` API returns as soon as the target index has been added to the cluster state, before any shards have been allocated.\nAt this point, all shards are in the state unassigned.\nIf, for any reason, the target index can't be allocated, its primary shard will remain unassigned until it can be allocated on that node.\n\nOnce the primary shard is allocated, it moves to state initializing, and the clone process begins.\nWhen the clone operation completes, the shard will become active.\nAt that point, Elasticsearch will try to allocate any replicas and may decide to relocate the primary shard to another node.\n\n**Wait for active shards**\n\nBecause the clone operation creates a new index to clone the shards to, the wait for active shards setting on index creation applies to the clone index action as well.", "docId": "indices-clone-index", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-clone-index.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-clone", "name": "indices.clone", "privileges": { "index": [ @@ -6497,7 +6497,7 @@ }, "description": "Close an index.\nA closed index is blocked for read or write operations and does not allow all operations that opened indices allow.\nIt is not possible to index documents or to search for documents in a closed index.\nClosed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster.\n\nWhen opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index.\nThe shards will then go through the normal recovery process.\nThe data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times.\n\nYou can open and close multiple indices.\nAn error is thrown if the request explicitly refers to a missing index.\nThis behaviour can be turned off using the `ignore_unavailable=true` parameter.\n\nBy default, you must explicitly name the indices you are opening or closing.\nTo open or close indices with `_all`, `*`, or other wildcard expressions, change the` action.destructive_requires_name` setting to `false`. This setting can also be changed with the cluster update settings API.\n\nClosed indices consume a significant amount of disk-space which can cause problems in managed environments.\nClosing indices can be turned off with the cluster settings API by setting `cluster.indices.close.enable` to `false`.", "docId": "indices-close", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-close.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-close", "name": "indices.close", "privileges": { "index": [ @@ -6537,7 +6537,7 @@ }, "description": "Create an index.\nYou can use the create index API to add a new index to an Elasticsearch cluster.\nWhen creating an index, you can specify the following:\n\n* Settings for the index.\n* Mappings for fields in the index.\n* Index aliases\n\n**Wait for active shards**\n\nBy default, index creation will only return a response to the client when the primary copies of each shard have been started, or the request times out.\nThe index creation response will indicate what happened.\nFor example, `acknowledged` indicates whether the index was successfully created in the cluster, `while shards_acknowledged` indicates whether the requisite number of shard copies were started for each shard in the index before timing out.\nNote that it is still possible for either `acknowledged` or `shards_acknowledged` to be `false`, but for the index creation to be successful.\nThese values simply indicate whether the operation completed before the timeout.\nIf `acknowledged` is false, the request timed out before the cluster state was updated with the newly created index, but it probably will be created sometime soon.\nIf `shards_acknowledged` is false, then the request timed out before the requisite number of shards were started (by default just the primaries), even if the cluster state was successfully updated to reflect the newly created index (that is to say, `acknowledged` is `true`).\n\nYou can change the default of only waiting for the primary shards to start through the index setting `index.write.wait_for_active_shards`.\nNote that changing this setting will also affect the `wait_for_active_shards` value on all subsequent write operations.", "docId": "indices-create-index", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-create-index.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create", "name": "indices.create", "privileges": { "index": [ @@ -6583,7 +6583,7 @@ "description": "Create a data stream.\n\nYou must have a matching index template with data stream enabled.", "docId": "indices-create-data-stream", "docTag": "data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-create-data-stream.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create-data-stream", "name": "indices.create_data_stream", "privileges": { "index": [ @@ -6666,7 +6666,7 @@ "description": "Get data stream stats.\n\nGet statistics for one or more data streams.", "docId": "data-stream-stats-api", "docTag": "data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-stream-stats-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-data-streams-stats-1", "name": "indices.data_streams_stats", "privileges": { "index": [ @@ -6712,7 +6712,7 @@ }, "description": "Delete indices.\nDeleting an index deletes its documents, shards, and metadata.\nIt does not delete related Kibana components, such as data views, visualizations, or dashboards.\n\nYou cannot delete the current write index of a data stream.\nTo delete the index, you must roll over the data stream so a new write index is created.\nYou can then use the delete index API to delete the previous write index.", "docId": "indices-delete-index", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-delete-index.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete", "name": "indices.delete", "privileges": { "index": [ @@ -6752,7 +6752,7 @@ }, "description": "Delete an alias.\nRemoves a data stream or index from an alias.", "docId": "indices-delete-alias", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-delete-alias.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-alias", "name": "indices.delete_alias", "privileges": { "index": [ @@ -6799,7 +6799,7 @@ }, "description": "Delete data stream lifecycles.\nRemoves the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.", "docId": "data-stream-delete-lifecycle", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams-delete-lifecycle.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-lifecycle", "name": "indices.delete_data_lifecycle", "request": { "name": "Request", @@ -6836,7 +6836,7 @@ "description": "Delete data streams.\nDeletes one or more data streams and their backing indices.", "docId": "data-stream-delete", "docTag": "data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-delete-data-stream.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-stream", "name": "indices.delete_data_stream", "privileges": { "index": [ @@ -6877,7 +6877,7 @@ }, "description": "Delete an index template.\nThe provided may contain multiple template names separated by a comma. If multiple template\nnames are specified then there is no wildcard support and the provided names should match completely with\nexisting templates.", "docId": "indices-delete-template", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-delete-template.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-index-template", "name": "indices.delete_index_template", "privileges": { "cluster": [ @@ -6913,7 +6913,7 @@ }, "description": "Delete a legacy index template.", "docId": "indices-delete-template-v1", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-delete-template-v1.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-template", "name": "indices.delete_template", "privileges": { "cluster": [ @@ -6954,7 +6954,7 @@ }, "description": "Analyze the index disk usage.\nAnalyze the disk usage of each field of an index or data stream.\nThis API might not support indices created in previous Elasticsearch versions.\nThe result of a small index can be inaccurate as some parts of an index might not be analyzed by the API.\n\nNOTE: The total size of fields of the analyzed shards of the index in the response is usually smaller than the index `store_size` value because some small metadata files are ignored and some parts of data files might not be scanned by the API.\nSince stored fields are stored together in a compressed format, the sizes of stored fields are also estimates and can be inaccurate.\nThe stored size of the `_id` field is likely underestimated while the `_source` field is overestimated.", "docId": "indices-disk-usage", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-disk-usage.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-disk-usage", "name": "indices.disk_usage", "request": { "name": "Request", @@ -6991,7 +6991,7 @@ "description": "Downsample an index.\nAggregate a time series (TSDS) index and store pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval.\nFor example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index.\nAll documents within an hour interval are summarized and stored as a single document in the downsample index.\n\nNOTE: Only indices in a time series data stream are supported.\nNeither field nor document level security can be defined on the source index.\nThe source index must be read only (`index.blocks.write: true`).", "docId": "indices-downsample-data-stream", "docTag": "data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-downsample-data-stream.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-downsample", "name": "indices.downsample", "request": { "name": "Request", @@ -7029,7 +7029,7 @@ }, "description": "Check indices.\nCheck if one or more indices, index aliases, or data streams exist.", "docId": "indices-exists", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-exists.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists", "name": "indices.exists", "request": { "name": "Request", @@ -7136,7 +7136,7 @@ }, "description": "Check existence of index templates.\nGet information about whether index templates exist.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.", "docId": "indices-template-exists-v1", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-template-exists-v1.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-template", "extDocId": "index-templates", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-templates.html", "name": "indices.exists_template", @@ -7180,7 +7180,7 @@ "description": "Get the status for a data stream lifecycle.\nGet information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.", "docId": "data-stream-explain-lifecycle", "docTag": "data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams-explain-lifecycle.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-explain-data-lifecycle", "name": "indices.explain_data_lifecycle", "request": { "name": "Request", @@ -7216,7 +7216,7 @@ }, "description": "Get field usage stats.\nGet field usage information for each shard and field of an index.\nField usage statistics are automatically captured when queries are running on a cluster.\nA shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use.\n\nThe response body reports the per-shard usage count of the data structures that back the fields in the index.\nA given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times.", "docId": "field-usage-stats", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/field-usage-stats.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-field-usage-stats", "name": "indices.field_usage_stats", "privileges": { "index": [ @@ -7256,7 +7256,7 @@ }, "description": "Flush data streams or indices.\nFlushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index.\nWhen restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart.\nElasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush.\n\nAfter each operation has been flushed it is permanently stored in the Lucene index.\nThis may mean that there is no need to maintain an additional copy of it in the transaction log.\nThe transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space.\n\nIt is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly.\nIf you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called.", "docId": "indices-flush", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-flush.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-flush", "name": "indices.flush", "privileges": { "index": [ @@ -7305,7 +7305,7 @@ }, "description": "Force a merge.\nPerform the force merge operation on the shards of one or more indices.\nFor data streams, the API forces a merge on the shards of the stream's backing indices.\n\nMerging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents.\nMerging normally happens automatically, but sometimes it is useful to trigger a merge manually.\n\nWARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes).\nWhen documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a \"tombstone\".\nThese soft-deleted documents are automatically cleaned up during regular segment merges.\nBut force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges.\nSo the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance.\nIf you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally.\n\n**Blocks during a force merge**\n\nCalls to this API block until the merge is complete (unless request contains `wait_for_completion=false`).\nIf the client connection is lost before completion then the force merge process will continue in the background.\nAny new requests to force merge the same indices will also block until the ongoing force merge is complete.\n\n**Running force merge asynchronously**\n\nIf the request contains `wait_for_completion=false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to get the status of the task.\nHowever, you can not cancel this task as the force merge task is not cancelable.\nElasticsearch creates a record of this task as a document at `_tasks/`.\nWhen you are done with a task, you should delete the task document so Elasticsearch can reclaim the space.\n\n**Force merging multiple indices**\n\nYou can force merge multiple indices with a single request by targeting:\n\n* One or more data streams that contain multiple backing indices\n* Multiple indices\n* One or more aliases\n* All data streams and indices in a cluster\n\nEach targeted shard is force-merged separately using the force_merge threadpool.\nBy default each node only has a single `force_merge` thread which means that the shards on that node are force-merged one at a time.\nIf you expand the `force_merge` threadpool on a node then it will force merge its shards in parallel\n\nForce merge makes the storage for the shard being merged temporarily increase, as it may require free space up to triple its size in case `max_num_segments parameter` is set to `1`, to rewrite all segments into a new one.\n\n**Data streams and time-based indices**\n\nForce-merging is useful for managing a data stream's older backing indices and other time-based indices, particularly after a rollover.\nIn these cases, each index only receives indexing traffic for a certain period of time.\nOnce an index receive no more writes, its shards can be force-merged to a single segment.\nThis can be a good idea because single-segment shards can sometimes use simpler and more efficient data structures to perform searches.\nFor example:\n\n```\nPOST /.ds-my-data-stream-2099.03.07-000001/_forcemerge?max_num_segments=1\n```", "docId": "indices-forcemerge", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-forcemerge.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-forcemerge", "extDocId": "index-modules-merge", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules-merge.html", "name": "indices.forcemerge", @@ -7353,7 +7353,7 @@ }, "description": "Get index information.\nGet information about one or more indices. For data streams, the API returns information about the\nstream’s backing indices.", "docId": "indices-get-index", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-get-index.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get", "name": "indices.get", "privileges": { "index": [ @@ -7394,7 +7394,7 @@ }, "description": "Get aliases.\nRetrieves information for one or more data stream or index aliases.", "docId": "indices-get-alias", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-get-alias.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-alias", "name": "indices.get_alias", "privileges": { "index": [ @@ -7454,7 +7454,7 @@ "description": "Get data stream lifecycles.\n\nGet the data stream lifecycle configuration of one or more data streams.", "docId": "data-stream-get-lifecycle", "docTag": "data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams-get-lifecycle.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-lifecycle", "name": "indices.get_data_lifecycle", "request": { "name": "Request", @@ -7487,7 +7487,7 @@ "description": "Get data stream lifecycle stats.\nGet statistics about the data streams that are managed by a data stream lifecycle.", "docId": "data-stream-lifecycle-stats", "docTag": "data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams-get-lifecycle-stats.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-lifecycle-stats", "name": "indices.get_data_lifecycle_stats", "privileges": { "cluster": [ @@ -7529,7 +7529,7 @@ "description": "Get data streams.\n\nGet information about one or more data streams.", "docId": "data-stream-get", "docTag": "data stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-get-data-stream.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream", "name": "indices.get_data_stream", "privileges": { "index": [ @@ -7571,7 +7571,7 @@ }, "description": "Get mapping definitions.\nRetrieves mapping definitions for one or more fields.\nFor data streams, the API retrieves field mappings for the stream’s backing indices.\n\nThis API is useful if you don't need a complete mapping or if an index mapping contains a large number of fields.", "docId": "indices-get-field-mapping", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-get-field-mapping.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-mapping", "name": "indices.get_field_mapping", "privileges": { "index": [ @@ -7618,7 +7618,7 @@ }, "description": "Get index templates.\nGet information about one or more index templates.", "docId": "indices-get-template", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-get-template.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-index-template", "name": "indices.get_index_template", "privileges": { "cluster": [ @@ -7664,7 +7664,7 @@ }, "description": "Get mapping definitions.\nFor data streams, the API retrieves mappings for the stream’s backing indices.", "docId": "indices-get-mapping", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-get-mapping.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-mapping", "name": "indices.get_mapping", "privileges": { "index": [ @@ -7750,7 +7750,7 @@ }, "description": "Get index settings.\nGet setting information for one or more indices.\nFor data streams, it returns setting information for the stream's backing indices.", "docId": "indices-get-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-get-settings.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings", "name": "indices.get_settings", "privileges": { "index": [ @@ -7804,7 +7804,7 @@ }, "description": "Get index templates.\nGet information about one or more index templates.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.", "docId": "indices-get-template-v1", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-get-template-v1.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-template", "extDocId": "index-templates", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-templates.html", "name": "indices.get_template", @@ -7968,7 +7968,7 @@ }, "description": "Open a closed index.\nFor data streams, the API opens any closed backing indices.\n\nA closed index is blocked for read/write operations and does not allow all operations that opened indices allow.\nIt is not possible to index documents or to search for documents in a closed index.\nThis allows closed indices to not have to maintain internal data structures for indexing or searching documents, resulting in a smaller overhead on the cluster.\n\nWhen opening or closing an index, the master is responsible for restarting the index shards to reflect the new state of the index.\nThe shards will then go through the normal recovery process.\nThe data of opened or closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times.\n\nYou can open and close multiple indices.\nAn error is thrown if the request explicitly refers to a missing index.\nThis behavior can be turned off by using the `ignore_unavailable=true` parameter.\n\nBy default, you must explicitly name the indices you are opening or closing.\nTo open or close indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`.\nThis setting can also be changed with the cluster update settings API.\n\nClosed indices consume a significant amount of disk-space which can cause problems in managed environments.\nClosing indices can be turned off with the cluster settings API by setting `cluster.indices.close.enable` to `false`.\n\nBecause opening or closing an index allocates its shards, the `wait_for_active_shards` setting on index creation applies to the `_open` and `_close` index actions as well.", "docId": "indices-open-close", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-open-close.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-open", "name": "indices.open", "privileges": { "index": [ @@ -8168,7 +8168,7 @@ }, "description": "Update field mappings.\nAdd new fields to an existing data stream or index.\nYou can also use this API to change the search settings of existing fields and add new properties to existing object fields.\nFor data streams, these changes are applied to all backing indices by default.\n\n**Add multi-fields to an existing field**\n\nMulti-fields let you index the same field in different ways.\nYou can use this API to update the fields mapping parameter and enable multi-fields for an existing field.\nWARNING: If an index (or data stream) contains documents when you add a multi-field, those documents will not have values for the new multi-field.\nYou can populate the new multi-field with the update by query API.\n\n**Change supported mapping parameters for an existing field**\n\nThe documentation for each mapping parameter indicates whether you can update it for an existing field using this API.\nFor example, you can use the update mapping API to update the `ignore_above` parameter.\n\n**Change the mapping of an existing field**\n\nExcept for supported mapping parameters, you can't change the mapping or field type of an existing field.\nChanging an existing field could invalidate data that's already indexed.\n\nIf you need to change the mapping of a field in a data stream's backing indices, refer to documentation about modifying data streams.\nIf you need to change the mapping of a field in other indices, create a new index with the correct mapping and reindex your data into that index.\n\n**Rename a field**\n\nRenaming a field would invalidate data already indexed under the old field name.\nInstead, add an alias field to create an alternate field name.", "docId": "indices-put-mapping", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-put-mapping.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-mapping", "extDocId": "mapping-params", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-params.html", "name": "indices.put_mapping", @@ -8214,7 +8214,7 @@ }, "description": "Update index settings.\nChanges dynamic index settings in real time.\nFor data streams, index setting changes are applied to all backing indices by default.\n\nTo revert a setting to the default value, use a null value.\nThe list of per-index settings that can be updated dynamically on live indices can be found in index module documentation.\nTo preserve existing settings from being updated, set the `preserve_existing` parameter to `true`.\n\nNOTE: You can only define new analyzers on closed indices.\nTo add an analyzer, you must close the index, define the analyzer, and reopen the index.\nYou cannot close the write index of a data stream.\nTo update the analyzer for a data stream's write index and future backing indices, update the analyzer in the index template used by the stream.\nThen roll over the data stream to apply the new analyzer to the stream's write index and future backing indices.\nThis affects searches and any new data added to the stream after the rollover.\nHowever, it does not affect the data stream's backing indices or their existing data.\nTo change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it.", "docId": "indices-update-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-update-settings.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-settings", "extDocId": "index-modules", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules.html", "name": "indices.put_settings", @@ -8261,7 +8261,7 @@ }, "description": "Create or update an index template.\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\nElasticsearch applies templates to new indices based on an index pattern that matches the index name.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.\n\nComposable templates always take precedence over legacy templates.\nIf no composable template matches a new index, matching legacy templates are applied according to their order.\n\nIndex templates are only applied during index creation.\nChanges to index templates do not affect existing indices.\nSettings and mappings specified in create index API requests override any settings or mappings specified in an index template.\n\nYou can use C-style `/* *\\/` block comments in index templates.\nYou can include comments anywhere in the request body, except before the opening curly bracket.\n\n**Indices matching multiple templates**\n\nMultiple index templates can potentially match an index, in this case, both the settings and mappings are merged into the final configuration of the index.\nThe order of the merging can be controlled using the order parameter, with lower order being applied first, and higher orders overriding them.\nNOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order.", "docId": "index-templates-v1", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-templates-v1.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-template", "extDocId": "index-templates", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-templates.html", "name": "indices.put_template", @@ -8308,7 +8308,7 @@ }, "description": "Get index recovery information.\nGet information about ongoing and completed shard recoveries for one or more indices.\nFor data streams, the API returns information for the stream's backing indices.\n\nAll recoveries, whether ongoing or complete, are kept in the cluster state and may be reported on at any time.\n\nShard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard.\nWhen a shard recovery completes, the recovered shard is available for search and indexing.\n\nRecovery automatically occurs during the following processes:\n\n* When creating an index for the first time.\n* When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path.\n* Creation of new replica shard copies from the primary.\n* Relocation of a shard copy to a different node in the same cluster.\n* A snapshot restore operation.\n* A clone, shrink, or split operation.\n\nYou can determine the cause of a shard recovery using the recovery or cat recovery APIs.\n\nThe index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster.\nIt only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist.\nThis means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API.", "docId": "indices-recovery", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-recovery.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-recovery", "name": "indices.recovery", "privileges": { "index": [ @@ -8354,7 +8354,7 @@ }, "description": "Refresh an index.\nA refresh makes recent operations performed on one or more indices available for search.\nFor data streams, the API runs the refresh operation on the stream’s backing indices.\n\nBy default, Elasticsearch periodically refreshes indices every second, but only on indices that have received one search request or more in the last 30 seconds.\nYou can change this default interval with the `index.refresh_interval` setting.\n\nRefresh requests are synchronous and do not return a response until the refresh operation completes.\n\nRefreshes are resource-intensive.\nTo ensure good cluster performance, it's recommended to wait for Elasticsearch's periodic refresh rather than performing an explicit refresh when possible.\n\nIf your application workflow indexes documents and then runs a search to retrieve the indexed document, it's recommended to use the index API's `refresh=wait_for` query parameter option.\nThis option ensures the indexing operation waits for a periodic refresh before running the search.", "docId": "indices-refresh", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-refresh.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-refresh", "name": "indices.refresh", "privileges": { "index": [ @@ -8399,7 +8399,7 @@ }, "description": "Reload search analyzers.\nReload an index's search analyzers and their resources.\nFor data streams, the API reloads search analyzers and resources for the stream's backing indices.\n\nIMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer.\n\nYou can use the reload search analyzers API to pick up changes to synonym files used in the `synonym_graph` or `synonym` token filter of a search analyzer.\nTo be eligible, the token filter must have an `updateable` flag of `true` and only be used in search analyzers.\n\nNOTE: This API does not perform a reload for each shard of an index.\nInstead, it performs a reload for each node containing index shards.\nAs a result, the total shard count returned by the API can differ from the number of index shards.\nBecause reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API.\nThis ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future.", "docId": "indices-reload-analyzers", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-reload-analyzers.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-reload-search-analyzers", "extDocId": "search-analyzer", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-analyzer.html", "name": "indices.reload_search_analyzers", @@ -8439,7 +8439,7 @@ }, "description": "Resolve the cluster.\nResolve the specified index expressions to return information about each cluster, including the local cluster, if included.\nMultiple patterns and remote clusters are supported.\n\nThis endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search.\n\nYou use the same index expression with this endpoint as you would for cross-cluster search.\nIndex and cluster exclusions are also supported with this endpoint.\n\nFor each cluster in the index expression, information is returned about:\n\n* Whether the querying (\"local\") cluster is currently connected to each remote cluster in the index expression scope.\n* Whether each remote cluster is configured with `skip_unavailable` as `true` or `false`.\n* Whether there are any indices, aliases, or data streams on that cluster that match the index expression.\n* Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index).\n* Cluster version information, including the Elasticsearch server version.\n\nFor example, `GET /_resolve/cluster/my-index-*,cluster*:my-index-*` returns information about the local cluster and all remotely configured clusters that start with the alias `cluster*`.\nEach cluster returns information about whether it has any indices, aliases or data streams that match `my-index-*`.\n\n**Advantages of using this endpoint before a cross-cluster search**\n\nYou may want to exclude a cluster or index from a search when:\n\n* A remote cluster is not currently connected and is configured with `skip_unavailable=false`. Running a cross-cluster search under those conditions will cause the entire search to fail.\n* A cluster has no matching indices, aliases or data streams for the index expression (or your user does not have permissions to search them). For example, suppose your index expression is `logs*,remote1:logs*` and the remote1 cluster has no indices, aliases or data streams that match `logs*`. In that case, that cluster will return no results from that cluster if you include it in a cross-cluster search.\n* The index expression (combined with any query parameters you specify) will likely cause an exception to be thrown when you do the search. In these cases, the \"error\" field in the `_resolve/cluster` response will be present. (This is also where security/permission errors will be shown.)\n* A remote cluster is an older version that does not support the feature you want to use in your search.", "docId": "indices-resolve-cluster-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-resolve-cluster-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster", "name": "indices.resolve_cluster", "privileges": { "index": [ @@ -8480,7 +8480,7 @@ }, "description": "Resolve indices.\nResolve the names and/or index patterns for indices, aliases, and data streams.\nMultiple patterns and remote clusters are supported.", "docId": "indices-resolve-index-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-resolve-index-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-index", "name": "indices.resolve_index", "privileges": { "index": [ @@ -8521,7 +8521,7 @@ }, "description": "Roll over to a new index.\nTIP: It is recommended to use the index lifecycle rollover action to automate rollovers.\n\nThe rollover API creates a new index for a data stream or index alias.\nThe API behavior depends on the rollover target.\n\n**Roll over a data stream**\n\nIf you roll over a data stream, the API creates a new write index for the stream.\nThe stream's previous write index becomes a regular backing index.\nA rollover also increments the data stream's generation.\n\n**Roll over an index alias with a write index**\n\nTIP: Prior to Elasticsearch 7.9, you'd typically use an index alias with a write index to manage time series data.\nData streams replace this functionality, require less maintenance, and automatically integrate with data tiers.\n\nIf an index alias points to multiple indices, one of the indices must be a write index.\nThe rollover API creates a new write index for the alias with `is_write_index` set to `true`.\nThe API also `sets is_write_index` to `false` for the previous write index.\n\n**Roll over an index alias with one index**\n\nIf you roll over an index alias that points to only one index, the API creates a new index for the alias and removes the original index from the alias.\n\nNOTE: A rollover creates a new index and is subject to the `wait_for_active_shards` setting.\n\n**Increment index names for an alias**\n\nWhen you roll over an index alias, you can specify a name for the new index.\nIf you don't specify a name and the current index ends with `-` and a number, such as `my-index-000001` or `my-index-3`, the new index name increments that number.\nFor example, if you roll over an alias with a current index of `my-index-000001`, the rollover creates a new index named `my-index-000002`.\nThis number is always six characters and zero-padded, regardless of the previous index's name.\n\nIf you use an index alias for time series data, you can use date math in the index name to track the rollover date.\nFor example, you can create an alias that points to an index named ``.\nIf you create the index on May 6, 2099, the index's name is `my-index-2099.05.06-000001`.\nIf you roll over the alias on May 7, 2099, the new index's name is `my-index-2099.05.07-000002`.", "docId": "indices-rollover-index", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-rollover-index.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-rollover", "name": "indices.rollover", "privileges": { "index": [ @@ -8570,7 +8570,7 @@ }, "description": "Get index segments.\nGet low-level information about the Lucene segments in index shards.\nFor data streams, the API returns information about the stream's backing indices.", "docId": "indices-segments", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-segments.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-segments", "name": "indices.segments", "privileges": { "index": [ @@ -8612,7 +8612,7 @@ }, "description": "Get index shard stores.\nGet store information about replica shards in one or more indices.\nFor data streams, the API retrieves store information for the stream's backing indices.\n\nThe index shard stores API returns the following information:\n\n* The node on which each replica shard exists.\n* The allocation ID for each replica shard.\n* A unique ID for each replica shard.\n* Any errors encountered while opening the shard index or from an earlier failure.\n\nBy default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards.", "docId": "indices-shards-stores", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-shards-stores.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-shard-stores", "name": "indices.shard_stores", "privileges": { "index": [ @@ -8655,7 +8655,7 @@ }, "description": "Shrink an index.\nShrink an index into a new index with fewer primary shards.\n\nBefore you can shrink an index:\n\n* The index must be read-only.\n* A copy of every shard in the index must reside on the same node.\n* The index must have a green health status.\n\nTo make shard allocation easier, we recommend you also remove the index's replica shards.\nYou can later re-add replica shards as part of the shrink operation.\n\nThe requested number of primary shards in the target index must be a factor of the number of shards in the source index.\nFor example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1.\nIf the number of shards in the index is a prime number it can only be shrunk into a single primary shard\n Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node.\n\nThe current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk.\n\nA shrink operation:\n\n* Creates a new target index with the same definition as the source index, but with a smaller number of primary shards.\n* Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks.\n* Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the `.routing.allocation.initial_recovery._id` index setting.\n\nIMPORTANT: Indices can only be shrunk if they satisfy the following requirements:\n\n* The target index must not exist.\n* The source index must have more primary shards than the target index.\n* The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index.\n* The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard.\n* The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index.", "docId": "indices-shrink-index", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-shrink-index.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-shrink", "name": "indices.shrink", "privileges": { "index": [ @@ -8700,7 +8700,7 @@ }, "description": "Simulate an index.\nGet the index configuration that would be applied to the specified index from an existing index template.", "docId": "indices-simulate", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-simulate-index.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-simulate-index-template", "name": "indices.simulate_index_template", "privileges": { "cluster": [ @@ -8743,7 +8743,7 @@ }, "description": "Simulate an index template.\nGet the index configuration that would be applied by a particular index template.", "docId": "indices-simulate-template", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-simulate-template.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-simulate-template", "name": "indices.simulate_template", "privileges": { "cluster": [ @@ -8789,7 +8789,7 @@ }, "description": "Split an index.\nSplit an index into a new index with more primary shards.\n* Before you can split an index:\n\n* The index must be read-only.\n* The cluster health status must be green.\n\nYou can do make an index read-only with the following request using the add index block API:\n\n```\nPUT /my_source_index/_block/write\n```\n\nThe current write index on a data stream cannot be split.\nIn order to split the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be split.\n\nThe number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the `index.number_of_routing_shards` setting.\nThe number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing.\nFor instance, a 5 shard index with `number_of_routing_shards` set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3.\n\nA split operation:\n\n* Creates a new target index with the same definition as the source index, but with a larger number of primary shards.\n* Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process.\n* Hashes all documents again, after low level files are created, to delete documents that belong to a different shard.\n* Recovers the target index as though it were a closed index which had just been re-opened.\n\nIMPORTANT: Indices can only be split if they satisfy the following requirements:\n\n* The target index must not exist.\n* The source index must have fewer primary shards than the target index.\n* The number of primary shards in the target index must be a multiple of the number of primary shards in the source index.\n* The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index.", "docId": "indices-split-index", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-split-index.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-split", "name": "indices.split", "privileges": { "index": [ @@ -8834,7 +8834,7 @@ }, "description": "Get index statistics.\nFor data streams, the API retrieves statistics for the stream's backing indices.\n\nBy default, the returned statistics are index-level with `primaries` and `total` aggregations.\n`primaries` are the values for only the primary shards.\n`total` are the accumulated values for both primary and replica shards.\n\nTo get shard-level statistics, set the `level` parameter to `shards`.\n\nNOTE: When moving to another node, the shard-level statistics for a shard are cleared.\nAlthough the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed.", "docId": "indices-stats", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-stats.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-stats", "name": "indices.stats", "privileges": { "index": [ @@ -8978,7 +8978,7 @@ }, "description": "Delete an inference endpoint", "docId": "inference-api-delete", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-inference-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-delete", "name": "inference.delete", "request": { "name": "Request", @@ -9021,7 +9021,7 @@ }, "description": "Get an inference endpoint", "docId": "inference-api-get", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-inference-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-get", "name": "inference.get", "request": { "name": "Request", @@ -9070,7 +9070,7 @@ }, "description": "Perform inference on the service.\n\nThis API enables you to use machine learning models to perform specific tasks on data that you provide as an input.\nIt returns a response with the results of the tasks.\nThe inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API.\n\n> info\n> The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", "docId": "inference-api-post", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/post-inference-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-inference", "name": "inference.inference", "privileges": { "cluster": [ @@ -9121,7 +9121,7 @@ }, "description": "Create an inference endpoint.\nWhen you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.\nAfter creating the endpoint, wait for the model deployment to complete before using it.\nTo verify the deployment status, use the get trained model statistics API.\nLook for `\"state\": \"fully_allocated\"` in the response and ensure that the `\"allocation_count\"` matches the `\"target_allocation_count\"`.\nAvoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", "docId": "inference-api-put", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-inference-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put", "name": "inference.put", "privileges": { "cluster": [ @@ -9168,7 +9168,7 @@ }, "description": "Perform streaming inference.\nGet real-time responses for completion tasks by delivering answers incrementally, reducing response times during computation.\nThis API works only with the completion task type.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.\n\nThis API requires the `monitor_inference` cluster privilege (the built-in `inference_admin` and `inference_user` roles grant this privilege). You must use a client that supports streaming.", "docId": "inference-api-stream", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/stream-inference-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-stream-inference", "name": "inference.stream_inference", "privileges": { "cluster": [ @@ -9260,7 +9260,7 @@ }, "description": "Update an inference endpoint.\n\nModify `task_settings`, secrets (within `service_settings`), or `num_allocations` for an inference endpoint, depending on the specific endpoint service and `task_type`.\n\nIMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face.\nFor built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.\nHowever, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.", "docId": "inference-api-update", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-inference-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-update", "name": "inference.update", "privileges": { "cluster": [ @@ -9310,7 +9310,7 @@ "description": "Get cluster info.\nGet basic build, version, and cluster information.", "docId": "api-root", "docTag": "info", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rest-api-root.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-info", "name": "info", "privileges": { "cluster": [ @@ -9385,7 +9385,7 @@ }, "description": "Delete IP geolocation database configurations.", "docId": "ip-location-delete-database", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-ip-location-database-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-delete-ip-location-database", "name": "ingest.delete_ip_location_database", "privileges": { "cluster": [ @@ -9426,7 +9426,7 @@ }, "description": "Delete pipelines.\nDelete one or more ingest pipelines.", "docId": "delete-pipeline-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-pipeline-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-delete-pipeline", "extDocId": "ingest", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest.html", "name": "ingest.delete_pipeline", @@ -9542,7 +9542,7 @@ }, "description": "Get IP geolocation database configurations.", "docId": "ip-location-get-database", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-ip-location-database-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-get-ip-location-database", "name": "ingest.get_ip_location_database", "privileges": { "cluster": [ @@ -9589,7 +9589,7 @@ }, "description": "Get pipelines.\n\nGet information about one or more ingest pipelines.\nThis API returns a local reference of the pipeline.", "docId": "get-pipeline-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-pipeline-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-get-pipeline", "extDocId": "ingest", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ingest.html", "name": "ingest.get_pipeline", @@ -9708,7 +9708,7 @@ }, "description": "Create or update an IP geolocation database configuration.", "docId": "ip-location-put-database", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-ip-location-database-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-put-ip-location-database", "name": "ingest.put_ip_location_database", "privileges": { "cluster": [ @@ -9793,7 +9793,7 @@ }, "description": "Simulate a pipeline.\n\nRun an ingest pipeline against a set of provided documents.\nYou can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.", "docId": "simulate-pipeline-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/simulate-pipeline-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-simulate", "name": "ingest.simulate", "privileges": { "cluster": [ @@ -9881,7 +9881,7 @@ }, "description": "Delete the license.\n\nWhen the license expires, your subscription level reverts to Basic.\n\nIf the operator privileges feature is enabled, only operator users can use this API.", "docId": "delete-license", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-license.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-delete", "extDocId": "license-management", "extDocUrl": "https://www.elastic.co/guide/en/kibana/{branch}/managing-licenses.html", "name": "license.delete", @@ -9923,7 +9923,7 @@ }, "description": "Get license information.\n\nGet information about your Elastic license including its type, its status, when it was issued, and when it expires.\n\n>info\n> If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.\n> If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.", "docId": "get-license", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-license.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-get", "name": "license.get", "request": { "name": "Request", @@ -9955,7 +9955,7 @@ }, "description": "Get the basic license status.", "docId": "get-basic-status", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-basic-status.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-get-basic-status", "name": "license.get_basic_status", "privileges": { "cluster": [ @@ -9992,7 +9992,7 @@ }, "description": "Get the trial status.", "docId": "get-trial-status", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-trial-status.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-get-trial-status", "name": "license.get_trial_status", "privileges": { "cluster": [ @@ -10028,7 +10028,7 @@ }, "description": "Update the license.\n\nYou can update your license at runtime without shutting down your nodes.\nLicense updates take effect immediately.\nIf the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response.\nYou must then re-submit the API request with the acknowledge parameter set to true.\n\nNOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license.\nIf the operator privileges feature is enabled, only operator users can use this API.", "docId": "update-license", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-license.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-post", "name": "license.post", "privileges": { "cluster": [ @@ -10069,7 +10069,7 @@ }, "description": "Start a basic license.\n\nStart an indefinite basic license, which gives access to all the basic features.\n\nNOTE: In order to start a basic license, you must not currently have a basic license.\n\nIf the basic license does not support all of the features that are available with your current license, however, you are notified in the response.\nYou must then re-submit the API request with the `acknowledge` parameter set to `true`.\n\nTo check the status of your basic license, use the get basic license API.", "docId": "start-basic", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/start-basic.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-post-start-basic", "name": "license.post_start_basic", "privileges": { "cluster": [ @@ -10106,7 +10106,7 @@ }, "description": "Start a trial.\nStart a 30-day trial, which gives access to all subscription features.\n\nNOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version.\nFor example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension.\n\nTo check the status of your trial, use the get trial status API.", "docId": "start-trial", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/start-trial.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-post-start-trial", "name": "license.post_start_trial", "privileges": { "cluster": [ @@ -10147,7 +10147,7 @@ }, "description": "Delete a Logstash pipeline.\nDelete a pipeline that is used for Logstash Central Management.\nIf the request succeeds, you receive an empty response with an appropriate status code.", "docId": "logstash-api-delete-pipeline", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/logstash-api-delete-pipeline.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-logstash-delete-pipeline", "extDocId": "logstash-centralized-pipeline-management", "extDocUrl": "https://www.elastic.co/guide/en/logstash/{branch}/logstash-centralized-pipeline-management.html", "name": "logstash.delete_pipeline", @@ -10190,7 +10190,7 @@ }, "description": "Get Logstash pipelines.\nGet pipelines that are used for Logstash Central Management.", "docId": "logstash-api-get-pipeline", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/logstash-api-get-pipeline.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-logstash-get-pipeline", "extDocId": "logstash-centralized-pipeline-management", "extDocUrl": "https://www.elastic.co/guide/en/logstash/{branch}/logstash-centralized-pipeline-management.html", "name": "logstash.get_pipeline", @@ -10239,7 +10239,7 @@ }, "description": "Create or update a Logstash pipeline.\n\nCreate a pipeline that is used for Logstash Central Management.\nIf the specified pipeline exists, it is replaced.", "docId": "logstash-api-put-pipeline", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/logstash-api-put-pipeline.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-logstash-put-pipeline", "extDocId": "logstash-centralized-pipeline-management", "extDocUrl": "https://www.elastic.co/guide/en/logstash/{branch}/logstash-centralized-pipeline-management.html", "name": "logstash.put_pipeline", @@ -10286,7 +10286,7 @@ "description": "Get multiple documents.\n\nGet multiple JSON documents by ID from one or more indices.\nIf you specify an index in the request URI, you only need to specify the document IDs in the request body.\nTo ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.\n\n**Filter source fields**\n\nBy default, the `_source` field is returned for every document (if stored).\nUse the `_source` and `_source_include` or `source_exclude` attributes to filter what fields are returned for a particular document.\nYou can include the `_source`, `_source_includes`, and `_source_excludes` query parameters in the request URI to specify the defaults to use when there are no per-document instructions.\n\n**Get stored fields**\n\nUse the `stored_fields` attribute to specify the set of stored fields you want to retrieve.\nAny requested fields that are not stored are ignored.\nYou can include the `stored_fields` query parameter in the request URI to specify the defaults to use when there are no per-document instructions.", "docId": "docs-multi-get", "docTag": "document", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-multi-get.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-mget", "name": "mget", "privileges": { "index": [ @@ -10334,7 +10334,7 @@ }, "description": "Get deprecation information.\nGet information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.\n\nTIP: This APIs is designed for indirect use by the Upgrade Assistant.\nYou are strongly recommended to use the Upgrade Assistant.", "docId": "migration-api-deprecation", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/migration-api-deprecation.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-migration-deprecations", "name": "migration.deprecations", "privileges": { "cluster": [ @@ -10377,7 +10377,7 @@ }, "description": "Get feature migration information.\nVersion upgrades sometimes require changes to how features store configuration information and data in system indices.\nCheck which features need to be migrated and the status of any migrations that are in progress.\n\nTIP: This API is designed for indirect use by the Upgrade Assistant.\nYou are strongly recommended to use the Upgrade Assistant.", "docId": "migration-api-feature-upgrade", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/feature-migration-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-migration-get-feature-upgrade-status", "name": "migration.get_feature_upgrade_status", "privileges": { "cluster": [ @@ -10417,7 +10417,7 @@ }, "description": "Start the feature migration.\nVersion upgrades sometimes require changes to how features store configuration information and data in system indices.\nThis API starts the automatic migration process.\n\nSome functionality might be temporarily unavailable during the migration process.\n\nTIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.", "docId": "migration-api-feature-upgrade", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/feature-migration-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-migration-get-feature-upgrade-status", "name": "migration.post_feature_upgrade", "privileges": { "cluster": [ @@ -10462,7 +10462,7 @@ "description": "Clear trained model deployment cache.\nCache will be cleared on all nodes where the trained model is assigned.\nA trained model deployment may have an inference cache enabled.\nAs requests are handled by each allocated node, their responses may be cached on that individual node.\nCalling this API clears the caches without restarting the deployment.", "docId": "clear-trained-model", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clear-trained-model-deployment-cache.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-clear-trained-model-deployment-cache", "name": "ml.clear_trained_model_deployment_cache", "privileges": { "cluster": [ @@ -10507,7 +10507,7 @@ "description": "Close anomaly detection jobs.\nA job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.\nWhen you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.\nIf you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.\nWhen a datafeed that has a specified end date stops, it automatically closes its associated job.", "docId": "ml-close-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-close-job.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-close-job", "name": "ml.close_job", "privileges": { "cluster": [ @@ -10552,7 +10552,7 @@ "description": "Delete a calendar.\nRemoves all scheduled events from a calendar, then deletes it.", "docId": "ml-delete-calendar", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-calendar.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-calendar", "name": "ml.delete_calendar", "privileges": { "cluster": [ @@ -10594,7 +10594,7 @@ "description": "Delete events from a calendar.", "docId": "ml-delete-calendar-event", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-calendar-event.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-calendar-event", "name": "ml.delete_calendar_event", "request": { "name": "Request", @@ -10631,7 +10631,7 @@ "description": "Delete anomaly jobs from a calendar.", "docId": "ml-delete-calendar-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-calendar-job.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-calendar-job", "name": "ml.delete_calendar_job", "privileges": { "cluster": [ @@ -10673,7 +10673,7 @@ "description": "Delete a data frame analytics job.", "docId": "ml-delete-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-dfanalytics.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-data-frame-analytics", "name": "ml.delete_data_frame_analytics", "privileges": { "cluster": [ @@ -10715,7 +10715,7 @@ "description": "Delete a datafeed.", "docId": "ml-delete-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-datafeed.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-datafeed", "name": "ml.delete_datafeed", "privileges": { "cluster": [ @@ -10757,7 +10757,7 @@ "description": "Delete expired ML data.\nDeletes all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using _all, by specifying * as the , or by omitting the\n.", "docId": "ml-delete-expired-data", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-expired-data.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-expired-data", "name": "ml.delete_expired_data", "privileges": { "cluster": [ @@ -10808,7 +10808,7 @@ "description": "Delete a filter.\nIf an anomaly detection job references the filter, you cannot delete the\nfilter. You must update or delete the job before you can delete the filter.", "docId": "ml-delete-filter", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-filter.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-filter", "name": "ml.delete_filter", "privileges": { "cluster": [ @@ -10850,7 +10850,7 @@ "description": "Delete forecasts from a job.\nBy default, forecasts are retained for 14 days. You can specify a\ndifferent retention period with the `expires_in` parameter in the forecast\njobs API. The delete forecast API enables you to delete one or more\nforecasts before they expire.", "docId": "ml-delete-forecast", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-forecast.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-forecast", "name": "ml.delete_forecast", "privileges": { "cluster": [ @@ -10898,7 +10898,7 @@ "description": "Delete an anomaly detection job.\nAll job configuration, model state and results are deleted.\nIt is not currently possible to delete multiple jobs using wildcards or a\ncomma separated list. If you delete a job that has a datafeed, the request\nfirst tries to delete the datafeed. This behavior is equivalent to calling\nthe delete datafeed API with the same timeout and force parameters as the\ndelete job request.", "docId": "ml-delete-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-job.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-job", "name": "ml.delete_job", "privileges": { "cluster": [ @@ -10940,7 +10940,7 @@ "description": "Delete a model snapshot.\nYou cannot delete the active model snapshot. To delete that snapshot, first\nrevert to a different one. To identify the active model snapshot, refer to\nthe `model_snapshot_id` in the results from the get jobs API.", "docId": "ml-delete-snapshot", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-snapshot.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-model-snapshot", "name": "ml.delete_model_snapshot", "privileges": { "cluster": [ @@ -10982,7 +10982,7 @@ "description": "Delete an unreferenced trained model.\nThe request deletes a trained inference model that is not referenced by an ingest pipeline.", "docId": "delete-trained-models", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-trained-models.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-trained-model", "name": "ml.delete_trained_model", "privileges": { "cluster": [ @@ -11024,7 +11024,7 @@ "description": "Delete a trained model alias.\nThis API deletes an existing model alias that refers to a trained model. If\nthe model alias is missing or refers to a model other than the one identified\nby the `model_id`, this API returns an error.", "docId": "delete-trained-models-aliases", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-trained-models-aliases.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-trained-model-alias", "name": "ml.delete_trained_model_alias", "privileges": { "cluster": [ @@ -11069,7 +11069,7 @@ "description": "Estimate job model memory usage.\nMakes an estimation of the memory usage for an anomaly detection job model.\nIt is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", "docId": "ml-estimate-memory", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-estimate-model-memory.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-estimate-model-memory", "name": "ml.estimate_model_memory", "privileges": { "cluster": [ @@ -11114,7 +11114,7 @@ "description": "Evaluate data frame analytics.\nThe API packages together commonly used evaluation metrics for various types\nof machine learning features. This has been designed for use on indexes\ncreated by data frame analytics. Evaluation requires both a ground truth\nfield and an analytics result field to be present.", "docId": "evaluate-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/evaluate-dfanalytics.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-evaluate-data-frame", "name": "ml.evaluate_data_frame", "privileges": { "cluster": [ @@ -11159,7 +11159,7 @@ "description": "Explain data frame analytics config.\nThis API provides explanations for a data frame analytics config that either\nexists already or one that has not been created yet. The following\nexplanations are provided:\n* which fields are included or not in the analysis and why,\n* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.\nIf you have object fields or fields that are excluded via source filtering, they are not included in the explanation.", "docId": "explain-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/explain-dfanalytics.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-explain-data-frame-analytics", "name": "ml.explain_data_frame_analytics", "privileges": { "cluster": [ @@ -11212,7 +11212,7 @@ "description": "Force buffered data to be processed.\nThe flush jobs API is only applicable when sending data for analysis using\nthe post data API. Depending on the content of the buffer, then it might\nadditionally calculate new results. Both flush and close operations are\nsimilar, however the flush is more efficient if you are expecting to send\nmore data for analysis. When flushing, the job remains open and is available\nto continue analyzing data. A close operation additionally prunes and\npersists the model state to disk and the job must be opened again before\nanalyzing further data.", "docId": "ml-flush-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-flush-job.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-flush-job", "name": "ml.flush_job", "privileges": { "cluster": [ @@ -11257,7 +11257,7 @@ "description": "Predict future behavior of a time series.\n\nForecasts are not supported for jobs that perform population analysis; an\nerror occurs if you try to create a forecast for a job that has an\n`over_field_name` in its configuration. Forcasts predict future behavior\nbased on historical data.", "docId": "ml-forecast", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-forecast.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-forecast", "name": "ml.forecast", "privileges": { "cluster": [ @@ -11302,7 +11302,7 @@ "description": "Get anomaly detection job results for buckets.\nThe API presents a chronological view of the records, grouped by bucket.", "docId": "ml-get-bucket", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-bucket.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-buckets", "name": "ml.get_buckets", "privileges": { "cluster": [ @@ -11355,7 +11355,7 @@ "description": "Get info about events in calendars.", "docId": "ml-get-calendar-event", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-calendar-event.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-calendar-events", "name": "ml.get_calendar_events", "privileges": { "cluster": [ @@ -11397,7 +11397,7 @@ "description": "Get calendar configuration info.", "docId": "ml-get-calendar", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-calendar.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-calendars", "name": "ml.get_calendars", "privileges": { "cluster": [ @@ -11450,7 +11450,7 @@ "description": "Get anomaly detection job results for categories.", "docId": "ml-get-category", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-category.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-categories", "name": "ml.get_categories", "privileges": { "cluster": [ @@ -11503,7 +11503,7 @@ "description": "Get data frame analytics job configuration info.\nYou can get information for multiple data frame analytics jobs in a single\nAPI request by using a comma-separated list of data frame analytics jobs or a\nwildcard expression.", "docId": "get-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-dfanalytics.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-data-frame-analytics", "name": "ml.get_data_frame_analytics", "privileges": { "cluster": [ @@ -11551,7 +11551,7 @@ "description": "Get data frame analytics jobs usage info.", "docId": "get-dfanalytics-stats", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-dfanalytics-stats.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-data-frame-analytics-stats", "name": "ml.get_data_frame_analytics_stats", "privileges": { "cluster": [ @@ -11599,7 +11599,7 @@ "description": "Get datafeeds usage info.\nYou can get statistics for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget statistics for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``. If the datafeed is stopped, the\nonly information you receive is the `datafeed_id` and the `state`.\nThis API returns a maximum of 10,000 datafeeds.", "docId": "ml-get-datafeed-stats", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-datafeed-stats.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-datafeed-stats", "name": "ml.get_datafeed_stats", "privileges": { "cluster": [ @@ -11647,7 +11647,7 @@ "description": "Get datafeeds configuration info.\nYou can get information for multiple datafeeds in a single API request by\nusing a comma-separated list of datafeeds or a wildcard expression. You can\nget information for all datafeeds by using `_all`, by specifying `*` as the\n``, or by omitting the ``.\nThis API returns a maximum of 10,000 datafeeds.", "docId": "ml-get-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-datafeed.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-datafeeds", "name": "ml.get_datafeeds", "privileges": { "cluster": [ @@ -11695,7 +11695,7 @@ "description": "Get filters.\nYou can get a single filter or all filters.", "docId": "ml-get-filter", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-filter.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-filters", "name": "ml.get_filters", "privileges": { "cluster": [ @@ -11743,7 +11743,7 @@ "description": "Get anomaly detection job results for influencers.\nInfluencers are the entities that have contributed to, or are to blame for,\nthe anomalies. Influencer results are available only if an\n`influencer_field_name` is specified in the job configuration.", "docId": "ml-get-influencer", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-influencer.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-influencers", "name": "ml.get_influencers", "privileges": { "cluster": [ @@ -11789,7 +11789,7 @@ "description": "Get anomaly detection jobs usage info.", "docId": "ml-get-job-stats", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-job-stats.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-job-stats", "name": "ml.get_job_stats", "privileges": { "cluster": [ @@ -11837,7 +11837,7 @@ "description": "Get anomaly detection jobs configuration info.\nYou can get information for multiple anomaly detection jobs in a single API\nrequest by using a group name, a comma-separated list of jobs, or a wildcard\nexpression. You can get information for all anomaly detection jobs by using\n`_all`, by specifying `*` as the ``, or by omitting the ``.", "docId": "ml-get-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-job.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-jobs", "name": "ml.get_jobs", "privileges": { "cluster": [ @@ -11884,7 +11884,7 @@ }, "description": "Get machine learning memory usage info.\nGet information about how machine learning jobs and trained models are using memory,\non each node, both within the JVM heap, and natively, outside of the JVM.", "docId": "ml-get-memory", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-ml-memory.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-memory-stats", "name": "ml.get_memory_stats", "privileges": { "cluster": [ @@ -11932,7 +11932,7 @@ "description": "Get anomaly detection job model snapshot upgrade usage info.", "docId": "ml-get-job-model-snapshot-upgrade-stats", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-job-model-snapshot-upgrade-stats.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-model-snapshot-upgrade-stats", "name": "ml.get_model_snapshot_upgrade_stats", "privileges": { "cluster": [ @@ -11974,7 +11974,7 @@ "description": "Get model snapshots info.", "docId": "ml-get-snapshot", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-snapshot.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-model-snapshots", "name": "ml.get_model_snapshots", "privileges": { "cluster": [ @@ -12027,7 +12027,7 @@ "description": "Get overall bucket results.\n\nRetrievs overall bucket results that summarize the bucket results of\nmultiple anomaly detection jobs.\n\nThe `overall_score` is calculated by combining the scores of all the\nbuckets within the overall bucket span. First, the maximum\n`anomaly_score` per anomaly detection job in the overall bucket is\ncalculated. Then the `top_n` of those scores are averaged to result in\nthe `overall_score`. This means that you can fine-tune the\n`overall_score` so that it is more or less sensitive to the number of\njobs that detect an anomaly at the same time. For example, if you set\n`top_n` to `1`, the `overall_score` is the maximum bucket score in the\noverall bucket. Alternatively, if you set `top_n` to the number of jobs,\nthe `overall_score` is high only when all jobs detect anomalies in that\noverall bucket. If you set the `bucket_span` parameter (to a value\ngreater than its default), the `overall_score` is the maximum\n`overall_score` of the overall buckets that have a span equal to the\njobs' largest bucket span.", "docId": "ml-get-overall-buckets", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-overall-buckets.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-overall-buckets", "name": "ml.get_overall_buckets", "privileges": { "cluster": [ @@ -12073,7 +12073,7 @@ "description": "Get anomaly records for an anomaly detection job.\nRecords contain the detailed analytical results. They describe the anomalous\nactivity that has been identified in the input data based on the detector\nconfiguration.\nThere can be many anomaly records depending on the characteristics and size\nof the input data. In practice, there are often too many to be able to\nmanually process them. The machine learning features therefore perform a\nsophisticated aggregation of the anomaly records into buckets.\nThe number of record results depends on the number of anomalies found in each\nbucket, which relates to the number of time series being modeled and the\nnumber of detectors.", "docId": "ml-get-record", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-get-record.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-records", "name": "ml.get_records", "privileges": { "cluster": [ @@ -12119,7 +12119,7 @@ "description": "Get trained model configuration info.", "docId": "get-trained-models", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-trained-models.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-trained-models", "name": "ml.get_trained_models", "privileges": { "cluster": [ @@ -12167,7 +12167,7 @@ "description": "Get trained models usage info.\nYou can get usage information for multiple trained\nmodels in a single API request by using a comma-separated list of model IDs or a wildcard expression.", "docId": "get-trained-models-stats", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-trained-models-stats.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-trained-models-stats", "name": "ml.get_trained_models_stats", "privileges": { "cluster": [ @@ -12215,7 +12215,7 @@ "description": "Evaluate a trained model.", "docId": "infer-trained-model", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/infer-trained-model.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-infer-trained-model", "name": "ml.infer_trained_model", "request": { "name": "Request", @@ -12264,7 +12264,7 @@ }, "description": "Get machine learning information.\nGet defaults and limits used by machine learning.\nThis endpoint is designed to be used by a user interface that needs to fully\nunderstand machine learning configurations where some options are not\nspecified, meaning that the defaults should be used. This endpoint may be\nused to find out what those defaults are. It also provides information about\nthe maximum size of machine learning jobs that could run in the current\ncluster configuration.", "docId": "get-ml-info", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-ml-info.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-info", "name": "ml.info", "privileges": { "cluster": [ @@ -12306,7 +12306,7 @@ "description": "Open anomaly detection jobs.\nAn anomaly detection job must be opened to be ready to receive and analyze\ndata. It can be opened and closed multiple times throughout its lifecycle.\nWhen you open a new job, it starts with an empty model.\nWhen you open an existing job, the most recent model state is automatically\nloaded. The job is ready to resume its analysis from where it left off, once\nnew data is received.", "docId": "ml-open-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-open-job.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-open-job", "name": "ml.open_job", "privileges": { "cluster": [ @@ -12351,7 +12351,7 @@ "description": "Add scheduled events to the calendar.", "docId": "ml-post-calendar-event", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-post-calendar-event.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-post-calendar-events", "name": "ml.post_calendar_events", "privileges": { "cluster": [ @@ -12396,7 +12396,7 @@ "description": "Send data to an anomaly detection job for analysis.\n\nIMPORTANT: For each job, data can be accepted from only a single connection at a time.\nIt is not currently possible to post data to multiple jobs using wildcards or a comma-separated list.", "docId": "ml-post-data", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-post-data.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-post-data", "name": "ml.post_data", "privileges": { "cluster": [ @@ -12442,7 +12442,7 @@ "description": "Preview features used by data frame analytics.\nPreview the extracted features used by a data frame analytics config.", "docId": "preview-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/preview-dfanalytics.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-preview-data-frame-analytics", "name": "ml.preview_data_frame_analytics", "privileges": { "cluster": [ @@ -12495,7 +12495,7 @@ "description": "Preview a datafeed.\nThis API returns the first \"page\" of search results from a datafeed.\nYou can preview an existing datafeed or provide configuration details for a datafeed\nand anomaly detection job in the API. The preview shows the structure of the data\nthat will be passed to the anomaly detection engine.\nIMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that\ncalled the API. However, when the datafeed starts it uses the roles of the last user that created or updated the\ndatafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials.\nYou can also use secondary authorization headers to supply the credentials.", "docId": "ml-preview-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-preview-datafeed.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-preview-datafeed", "name": "ml.preview_datafeed", "privileges": { "cluster": [ @@ -12551,7 +12551,7 @@ "description": "Create a calendar.", "docId": "ml-put-calendar", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-put-calendar.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-calendar", "name": "ml.put_calendar", "privileges": { "cluster": [ @@ -12596,7 +12596,7 @@ "description": "Add anomaly detection job to calendar.", "docId": "ml-put-calendar-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-put-calendar-job.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-calendar-job", "name": "ml.put_calendar_job", "privileges": { "cluster": [ @@ -12638,7 +12638,7 @@ "description": "Create a data frame analytics job.\nThis API creates a data frame analytics job that performs an analysis on the\nsource indices and stores the outcome in a destination index.\nBy default, the query used in the source configuration is `{\"match_all\": {}}`.\n\nIf the destination index does not exist, it is created automatically when you start the job.\n\nIf you supply only a subset of the regression or classification parameters, hyperparameter optimization occurs. It determines a value for each of the undefined parameters.", "docId": "put-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-dfanalytics.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-data-frame-analytics", "name": "ml.put_data_frame_analytics", "privileges": { "cluster": [ @@ -12690,7 +12690,7 @@ "description": "Create a datafeed.\nDatafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job.\nYou can associate only one datafeed with each anomaly detection job.\nThe datafeed contains a query that runs at a defined interval (`frequency`).\nIf you are concerned about delayed data, you can add a delay (`query_delay') at each interval.\nBy default, the datafeed uses the following query: `{\"match_all\": {\"boost\": 1}}`.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had\nat the time of creation and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.\nYou must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed\ndirectly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index.", "docId": "ml-put-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-put-datafeed.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-datafeed", "name": "ml.put_datafeed", "privileges": { "cluster": [ @@ -12738,7 +12738,7 @@ "description": "Create a filter.\nA filter contains a list of strings. It can be used by one or more anomaly detection jobs.\nSpecifically, filters are referenced in the `custom_rules` property of detector configuration objects.", "docId": "ml-put-filter", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-put-filter.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-filter", "name": "ml.put_filter", "privileges": { "cluster": [ @@ -12783,7 +12783,7 @@ "description": "Create an anomaly detection job.\nIf you include a `datafeed_config`, you must have read index privileges on the source index.\nIf you include a `datafeed_config` but do not provide a query, the datafeed uses `{\"match_all\": {\"boost\": 1}}`.", "docId": "ml-put-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-put-job.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-job", "name": "ml.put_job", "privileges": { "cluster": [ @@ -12831,7 +12831,7 @@ "description": "Create a trained model.\nEnable you to supply a trained model that is not created by data frame analytics.", "docId": "put-trained-models", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-trained-models.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model", "name": "ml.put_trained_model", "privileges": { "cluster": [ @@ -12876,7 +12876,7 @@ "description": "Create or update a trained model alias.\nA trained model alias is a logical name used to reference a single trained\nmodel.\nYou can use aliases instead of trained model identifiers to make it easier to\nreference your models. For example, you can use aliases in inference\naggregations and processors.\nAn alias must be unique and refer to only a single trained model. However,\nyou can have multiple aliases for each trained model.\nIf you use this API to update an alias such that it references a different\ntrained model ID and the model uses a different type of data frame analytics,\nan error occurs. For example, this situation occurs if you have a trained\nmodel for regression analysis and a trained model for classification\nanalysis; you cannot reassign an alias from one type of trained model to\nanother.\nIf you use this API to update an alias and there are very few input fields in\ncommon between the old and new trained models for the model alias, the API\nreturns a warning.", "docId": "put-trained-models-aliases", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-trained-models-aliases.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model-alias", "name": "ml.put_trained_model_alias", "privileges": { "cluster": [ @@ -12921,7 +12921,7 @@ "description": "Create part of a trained model definition.", "docId": "put-trained-model-definition-part", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-trained-model-definition-part.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model-definition-part", "name": "ml.put_trained_model_definition_part", "privileges": { "cluster": [ @@ -12966,7 +12966,7 @@ "description": "Create a trained model vocabulary.\nThis API is supported only for natural language processing (NLP) models.\nThe vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition.", "docId": "put-trained-model-vocabulary", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-trained-model-vocabulary.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model-vocabulary", "name": "ml.put_trained_model_vocabulary", "privileges": { "cluster": [ @@ -13011,7 +13011,7 @@ "description": "Reset an anomaly detection job.\nAll model state and results are deleted. The job is ready to start over as if\nit had just been created.\nIt is not currently possible to reset multiple jobs using wildcards or a\ncomma separated list.", "docId": "ml-reset-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-reset-job.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-reset-job", "name": "ml.reset_job", "privileges": { "cluster": [ @@ -13053,7 +13053,7 @@ "description": "Revert to a snapshot.\nThe machine learning features react quickly to anomalous input, learning new\nbehaviors in data. Highly anomalous input increases the variance in the\nmodels whilst the system learns whether this is a new step-change in behavior\nor a one-off event. In the case where this anomalous input is known to be a\none-off, then it might be appropriate to reset the model state to a time\nbefore this event. For example, you might consider reverting to a saved\nsnapshot after Black Friday or a critical system failure.", "docId": "ml-revert-snapshot", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-revert-snapshot.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-revert-model-snapshot", "name": "ml.revert_model_snapshot", "privileges": { "cluster": [ @@ -13097,7 +13097,7 @@ }, "description": "Set upgrade_mode for ML indices.\nSets a cluster wide upgrade_mode setting that prepares machine learning\nindices for an upgrade.\nWhen upgrading your cluster, in some circumstances you must restart your\nnodes and reindex your machine learning indices. In those circumstances,\nthere must be no machine learning jobs running. You can close the machine\nlearning jobs, do the upgrade, then open all the jobs again. Alternatively,\nyou can use this API to temporarily halt tasks associated with the jobs and\ndatafeeds and prevent new jobs from opening. You can also use this API\nduring upgrades that do not require you to reindex your machine learning\nindices, though stopping jobs is not a requirement in that case.\nYou can see the current value for the upgrade_mode setting by using the get\nmachine learning info API.", "docId": "ml-set-upgrade-mode", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-set-upgrade-mode.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-set-upgrade-mode", "name": "ml.set_upgrade_mode", "privileges": { "cluster": [ @@ -13139,7 +13139,7 @@ "description": "Start a data frame analytics job.\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.\nIf the destination index does not exist, it is created automatically the\nfirst time you start the data frame analytics job. The\n`index.number_of_shards` and `index.number_of_replicas` settings for the\ndestination index are copied from the source index. If there are multiple\nsource indices, the destination index copies the highest setting values. The\nmappings for the destination index are also copied from the source indices.\nIf there are any mapping conflicts, the job fails to start.\nIf the destination index exists, it is used as is. You can therefore set up\nthe destination index in advance with custom settings and mappings.", "docId": "start-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/start-dfanalytics.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-data-frame-analytics", "name": "ml.start_data_frame_analytics", "privileges": { "cluster": [ @@ -13191,7 +13191,7 @@ "description": "Start datafeeds.\n\nA datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.\n\nBefore you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.\n\nIf you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.\nIf new data was indexed for that exact millisecond between stopping and starting, it will be ignored.\n\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or\nupdate it had at the time of creation or update and runs the query using those same roles. If you provided secondary\nauthorization headers when you created or updated the datafeed, those credentials are used instead.", "docId": "ml-start-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-start-datafeed.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-datafeed", "name": "ml.start_datafeed", "privileges": { "cluster": [ @@ -13236,7 +13236,7 @@ "description": "Start a trained model deployment.\nIt allocates the model to every machine learning node.", "docId": "start-trained-model-deployment", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/start-trained-model-deployment.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-trained-model-deployment", "name": "ml.start_trained_model_deployment", "privileges": { "cluster": [ @@ -13281,7 +13281,7 @@ "description": "Stop data frame analytics jobs.\nA data frame analytics job can be started and stopped multiple times\nthroughout its lifecycle.", "docId": "stop-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/stop-dfanalytics.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-data-frame-analytics", "name": "ml.stop_data_frame_analytics", "privileges": { "cluster": [ @@ -13326,7 +13326,7 @@ "description": "Stop datafeeds.\nA datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped\nmultiple times throughout its lifecycle.", "docId": "ml-stop-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-stop-datafeed.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-datafeed", "name": "ml.stop_datafeed", "privileges": { "cluster": [ @@ -13371,7 +13371,7 @@ "description": "Stop a trained model deployment.", "docId": "stop-trained-model-deployment", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/stop-trained-model-deployment.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-trained-model-deployment", "name": "ml.stop_trained_model_deployment", "privileges": { "cluster": [ @@ -13416,7 +13416,7 @@ "description": "Update a data frame analytics job.", "docId": "update-dfanalytics", "docTag": "ml data frame", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-dfanalytics.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-data-frame-analytics", "name": "ml.update_data_frame_analytics", "privileges": { "cluster": [ @@ -13468,7 +13468,7 @@ "description": "Update a datafeed.\nYou must stop and start the datafeed for the changes to be applied.\nWhen Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at\nthe time of the update and runs the query using those same roles. If you provide secondary authorization headers,\nthose credentials are used instead.", "docId": "ml-update-datafeed", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-update-datafeed.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-datafeed", "name": "ml.update_datafeed", "privileges": { "cluster": [ @@ -13513,7 +13513,7 @@ "description": "Update a filter.\nUpdates the description of a filter, adds items, or removes items from the list.", "docId": "ml-update-filter", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-update-filter.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-filter", "name": "ml.update_filter", "privileges": { "cluster": [ @@ -13558,7 +13558,7 @@ "description": "Update an anomaly detection job.\nUpdates certain properties of an anomaly detection job.", "docId": "ml-update-job", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-update-job.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-job", "name": "ml.update_job", "privileges": { "cluster": [ @@ -13603,7 +13603,7 @@ "description": "Update a snapshot.\nUpdates certain properties of a snapshot.", "docId": "ml-update-snapshot", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-update-snapshot.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-model-snapshot", "name": "ml.update_model_snapshot", "privileges": { "cluster": [ @@ -13648,7 +13648,7 @@ "description": "Update a trained model deployment.", "docId": "update-trained-model-deployment", "docTag": "ml trained model", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-trained-model-deployment.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-trained-model-deployment", "name": "ml.update_trained_model_deployment", "privileges": { "cluster": [ @@ -13693,7 +13693,7 @@ "description": "Upgrade a snapshot.\nUpgrade an anomaly detection model snapshot to the latest major version.\nOver time, older snapshot formats are deprecated and removed. Anomaly\ndetection jobs support only snapshots that are from the current or previous\nmajor version.\nThis API provides a means to upgrade a snapshot to the current major version.\nThis aids in preparing the cluster for an upgrade to the next major version.\nOnly one snapshot per anomaly detection job can be upgraded at a time and the\nupgraded snapshot cannot be the current snapshot of the anomaly detection\njob.", "docId": "ml-upgrade-job-model-snapshot", "docTag": "ml anomaly", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-upgrade-job-model-snapshot.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-upgrade-job-snapshot", "name": "ml.upgrade_job_snapshot", "privileges": { "cluster": [ @@ -13864,7 +13864,7 @@ "description": "Run multiple searches.\n\nThe format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format.\nThe structure is as follows:\n\n```\nheader\\n\nbody\\n\nheader\\n\nbody\\n\n```\n\nThis structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.\n\nIMPORTANT: The final line of data must end with a newline character `\\n`.\nEach newline character may be preceded by a carriage return `\\r`.\nWhen sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.", "docId": "search-multi-search", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-multi-search.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch", "name": "msearch", "privileges": { "index": [ @@ -13917,7 +13917,7 @@ "description": "Run multiple templated searches.\n\nRun multiple templated searches with a single request.\nIf you are providing a text file or text input to `curl`, use the `--data-binary` flag instead of `-d` to preserve newlines.\nFor example:\n\n```\n$ cat requests\n{ \"index\": \"my-index\" }\n{ \"id\": \"my-search-template\", \"params\": { \"query_string\": \"hello world\", \"from\": 0, \"size\": 10 }}\n{ \"index\": \"my-other-index\" }\n{ \"id\": \"my-other-search-template\", \"params\": { \"query_type\": \"match_all\" }}\n\n$ curl -H \"Content-Type: application/x-ndjson\" -XGET localhost:9200/_msearch/template --data-binary \"@requests\"; echo\n```", "docId": "search-multi-search-template", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/multi-search-template.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch-template", "extDocId": "search-templates", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-template.html", "name": "msearch_template", @@ -13971,7 +13971,7 @@ "description": "Get multiple term vectors.\n\nGet multiple term vectors with a single request.\nYou can specify existing documents by index and ID or provide artificial documents in the body of the request.\nYou can specify the index in the request body or request URI.\nThe response contains a `docs` array with all the fetched termvectors.\nEach element has the structure provided by the termvectors API.\n\n**Artificial documents**\n\nYou can also use `mtermvectors` to generate term vectors for artificial documents provided in the body of the request.\nThe mapping used is determined by the specified `_index`.", "docId": "docs-multi-termvectors", "docTag": "document", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-multi-termvectors.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-mtermvectors", "name": "mtermvectors", "privileges": { "index": [ @@ -14024,7 +14024,7 @@ "description": "Clear the archived repositories metering.\nClear the archived repositories metering information in the cluster.", "docId": "clear-repositories-metering-archive-api", "docTag": "cluster", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clear-repositories-metering-archive-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-clear-repositories-metering-archive", "name": "nodes.clear_repositories_metering_archive", "privileges": { "cluster": [ @@ -14067,7 +14067,7 @@ "description": "Get cluster repositories metering.\nGet repositories metering information for a cluster.\nThis API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time.\nAdditionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts.", "docId": "get-repositories-metering-api", "docTag": "cluster", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-repositories-metering-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-get-repositories-metering-info", "name": "nodes.get_repositories_metering_info", "privileges": { "cluster": [ @@ -14109,7 +14109,7 @@ "description": "Get the hot threads for nodes.\nGet a breakdown of the hot threads on each selected node in the cluster.\nThe output is plain text with a breakdown of the top hot threads for each node.", "docId": "cluster-nodes-hot-threads", "docTag": "cluster", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-hot-threads.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-hot-threads", "name": "nodes.hot_threads", "privileges": { "cluster": [ @@ -14158,7 +14158,7 @@ "description": "Get node information.\nBy default, the API returns all attributes and core settings for cluster nodes.", "docId": "cluster-nodes-info", "docTag": "cluster", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-info.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-info", "name": "nodes.info", "request": { "name": "Request", @@ -14209,7 +14209,7 @@ "description": "Reload the keystore on nodes in the cluster.\n\nSecure settings are stored in an on-disk keystore. Certain of these settings are reloadable.\nThat is, you can change them on disk and reload them without restarting any nodes in the cluster.\nWhen you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node.\n\nWhen the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings.\nReloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted.\nAlternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password.", "docId": "cluster-nodes-reload-secure-settings", "docTag": "cluster", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-reload-secure-settings.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-reload-secure-settings", "name": "nodes.reload_secure_settings", "request": { "name": "Request", @@ -14254,7 +14254,7 @@ "description": "Get node statistics.\nGet statistics for nodes in a cluster.\nBy default, all stats are returned. You can limit the returned information by using metrics.", "docId": "cluster-nodes-stats", "docTag": "cluster", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-stats.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-stats", "name": "nodes.stats", "privileges": { "cluster": [ @@ -14327,7 +14327,7 @@ "description": "Get feature usage information.", "docId": "cluster-nodes-usage", "docTag": "cluster", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-usage.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-usage", "name": "nodes.usage", "privileges": { "cluster": [ @@ -14388,7 +14388,7 @@ "description": "Open a point in time.\n\nA search request by default runs against the most recent visible data of the target indices,\nwhich is called point in time. Elasticsearch pit (point in time) is a lightweight view into the\nstate of the data as it existed when initiated. In some cases, it’s preferred to perform multiple\nsearch requests using the same point in time. For example, if refreshes happen between\n`search_after` requests, then the results of those requests might not be consistent as changes happening\nbetween searches are only visible to the more recent point in time.\n\nA point in time must be opened explicitly before being used in search requests.\n\nA subsequent search request with the `pit` parameter must not specify `index`, `routing`, or `preference` values as these parameters are copied from the point in time.\n\nJust like regular searches, you can use `from` and `size` to page through point in time search results, up to the first 10,000 hits.\nIf you want to retrieve more hits, use PIT with `search_after`.\n\nIMPORTANT: The open point in time request and each subsequent search request can return different identifiers; always use the most recently received ID for the next search request.\n\nWhen a PIT that contains shard failures is used in a search request, the missing are always reported in the search response as a `NoShardAvailableActionException` exception.\nTo get rid of these exceptions, a new PIT needs to be created so that shards missing from the previous PIT can be handled, assuming they become available in the meantime.\n\n**Keeping point in time alive**\n\nThe `keep_alive` parameter, which is passed to a open point in time request and search request, extends the time to live of the corresponding point in time.\nThe value does not need to be long enough to process all data — it just needs to be long enough for the next request.\n\nNormally, the background merge process optimizes the index by merging together smaller segments to create new, bigger segments.\nOnce the smaller segments are no longer needed they are deleted.\nHowever, open point-in-times prevent the old segments from being deleted since they are still in use.\n\nTIP: Keeping older segments alive means that more disk space and file handles are needed.\nEnsure that you have configured your nodes to have ample free file handles.\n\nAdditionally, if a segment contains deleted or updated documents then the point in time must keep track of whether each document in the segment was live at the time of the initial search request.\nEnsure that your nodes have sufficient heap space if you have many open point-in-times on an index that is subject to ongoing deletes or updates.\nNote that a point-in-time doesn't prevent its associated indices from being deleted.\nYou can check how many point-in-times (that is, search contexts) are open with the nodes stats API.", "docId": "point-in-time-api", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/point-in-time-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time", "name": "open_point_in_time", "privileges": { "index": [ @@ -14432,7 +14432,7 @@ "description": "Ping the cluster.\nGet information about whether the cluster is running.", "docId": "cluster-ping", "docTag": "cluster", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cluster", "name": "ping", "request": { "name": "Request", @@ -14577,7 +14577,7 @@ "description": "Create or update a script or search template.\nCreates or updates a stored script or search template.", "docId": "script-put", "docTag": "script", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/create-stored-script-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-put-script", "extDocId": "search-template", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-template.html", "name": "put_script", @@ -14631,7 +14631,7 @@ }, "description": "Delete a query rule.\nDelete a query rule within a query ruleset.\nThis is a destructive action that is only recoverable by re-adding the same rule with the create or update query rule API.", "docId": "query-rule-delete", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-query-rule.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-delete-rule", "name": "query_rules.delete_rule", "privileges": { "cluster": [ @@ -14672,7 +14672,7 @@ }, "description": "Delete a query ruleset.\nRemove a query ruleset and its associated data.\nThis is a destructive action that is not recoverable.", "docId": "query-ruleset-delete", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-query-ruleset.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-delete-ruleset", "name": "query_rules.delete_ruleset", "privileges": { "cluster": [ @@ -14713,7 +14713,7 @@ }, "description": "Get a query rule.\nGet details about a query rule within a query ruleset.", "docId": "query-rule-get", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-query-rule.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-get-rule", "extDocId": "query-rule", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-using-query-rules.html", "name": "query_rules.get_rule", @@ -14756,7 +14756,7 @@ }, "description": "Get a query ruleset.\nGet details about a query ruleset.", "docId": "query-ruleset-get", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-query-ruleset.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-get-ruleset", "name": "query_rules.get_ruleset", "privileges": { "cluster": [ @@ -14797,7 +14797,7 @@ }, "description": "Get all query rulesets.\nGet summarized information about the query rulesets.", "docId": "query-ruleset-list", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/list-query-rulesets.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-list-rulesets", "name": "query_rules.list_rulesets", "privileges": { "cluster": [ @@ -14838,7 +14838,7 @@ }, "description": "Create or update a query rule.\nCreate or update a query rule within a query ruleset.\n\nIMPORTANT: Due to limitations within pinned queries, you can only pin documents using ids or docs, but cannot use both in single rule.\nIt is advised to use one or the other in query rulesets, to avoid errors.\nAdditionally, pinned queries have a maximum limit of 100 pinned hits.\nIf multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset.", "docId": "query-rule-put", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-query-rule.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-put-rule", "name": "query_rules.put_rule", "privileges": { "cluster": [ @@ -14882,7 +14882,7 @@ }, "description": "Create or update a query ruleset.\nThere is a limit of 100 rules per ruleset.\nThis limit can be increased by using the `xpack.applications.rules.max_rules_per_ruleset` cluster setting.\n\nIMPORTANT: Due to limitations within pinned queries, you can only select documents using `ids` or `docs`, but cannot use both in single rule.\nIt is advised to use one or the other in query rulesets, to avoid errors.\nAdditionally, pinned queries have a maximum limit of 100 pinned hits.\nIf multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset.", "docId": "query-ruleset-put", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-query-ruleset.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-put-ruleset", "extDocId": "query-rule", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-using-query-rules.html", "name": "query_rules.put_ruleset", @@ -14928,7 +14928,7 @@ }, "description": "Test a query ruleset.\nEvaluate match criteria against a query ruleset to identify the rules that would match that criteria.", "docId": "query-ruleset-test", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/test-query-ruleset.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-test", "name": "query_rules.test", "privileges": { "cluster": [ @@ -14973,7 +14973,7 @@ "description": "Evaluate ranked search results.\n\nEvaluate the quality of ranked search results over a set of typical search queries.", "docId": "search-rank-eval", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rank-eval", "name": "rank_eval", "privileges": { "index": [ @@ -15026,7 +15026,7 @@ "description": "Reindex documents.\n\nCopy documents from a source to a destination.\nYou can copy all documents to the destination index or reindex a subset of the documents.\nThe source can be any existing index, alias, or data stream.\nThe destination must differ from the source.\nFor example, you cannot reindex a data stream into itself.\n\nIMPORTANT: Reindex requires `_source` to be enabled for all documents in the source.\nThe destination should be configured as wanted before calling the reindex API.\nReindex does not copy the settings from the source or its associated template.\nMappings, shard counts, and replicas, for example, must be configured ahead of time.\n\nIf the Elasticsearch security features are enabled, you must have the following security privileges:\n\n* The `read` index privilege for the source data stream, index, or alias.\n* The `write` index privilege for the destination data stream, index, or index alias.\n* To automatically create a data stream or index with a reindex API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege for the destination data stream, index, or alias.\n* If reindexing from a remote cluster, the `source.remote.user` must have the `monitor` cluster privilege and the `read` index privilege for the source data stream, index, or alias.\n\nIf reindexing from a remote cluster, you must explicitly allow the remote host in the `reindex.remote.whitelist` setting.\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nThe `dest` element can be configured like the index API to control optimistic concurrency control.\nOmitting `version_type` or setting it to `internal` causes Elasticsearch to blindly dump documents into the destination, overwriting any that happen to have the same ID.\n\nSetting `version_type` to `external` causes Elasticsearch to preserve the `version` from the source, create any documents that are missing, and update any documents that have an older version in the destination than they do in the source.\n\nSetting `op_type` to `create` causes the reindex API to create only missing documents in the destination.\nAll existing documents will cause a version conflict.\n\nIMPORTANT: Because data streams are append-only, any reindex request to a destination data stream must have an `op_type` of `create`.\nA reindex can only add new documents to a destination data stream.\nIt cannot update existing documents in a destination data stream.\n\nBy default, version conflicts abort the reindex process.\nTo continue reindexing if there are conflicts, set the `conflicts` request body property to `proceed`.\nIn this case, the response includes a count of the version conflicts that were encountered.\nNote that the handling of other error types is unaffected by the `conflicts` property.\nAdditionally, if you opt to count version conflicts, the operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query.\n\nNOTE: The reindex API makes no effort to handle ID collisions.\nThe last document written will \"win\" but the order isn't usually predictable so it is not a good idea to rely on this behavior.\nInstead, make sure that IDs are unique by using a script.\n\n**Running reindex asynchronously**\n\nIf the request contains `wait_for_completion=false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to cancel or get the status of the task.\nElasticsearch creates a record of this task as a document at `_tasks/`.\n\n**Reindex from multiple sources**\n\nIf you have many sources to reindex it is generally better to reindex them one at a time rather than using a glob pattern to pick up multiple sources.\nThat way you can resume the process if there are any errors by removing the partially completed source and starting over.\nIt also makes parallelizing the process fairly simple: split the list of sources to reindex and run each list in parallel.\n\nFor example, you can use a bash script like this:\n\n```\nfor index in i1 i2 i3 i4 i5; do\n curl -HContent-Type:application/json -XPOST localhost:9200/_reindex?pretty -d'{\n \"source\": {\n \"index\": \"'$index'\"\n },\n \"dest\": {\n \"index\": \"'$index'-reindexed\"\n }\n }'\ndone\n```\n\n**Throttling**\n\nSet `requests_per_second` to any positive decimal number (`1.4`, `6`, `1000`, for example) to throttle the rate at which reindex issues batches of index operations.\nRequests are throttled by padding each batch with a wait time.\nTo turn off throttling, set `requests_per_second` to `-1`.\n\nThe throttling is done by waiting between batches so that the scroll that reindex uses internally can be given a timeout that takes into account the padding.\nThe padding time is the difference between the batch size divided by the `requests_per_second` and the time spent writing.\nBy default the batch size is `1000`, so if `requests_per_second` is set to `500`:\n\n```\ntarget_time = 1000 / 500 per second = 2 seconds\nwait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds\n```\n\nSince the batch is issued as a single bulk request, large batch sizes cause Elasticsearch to create many requests and then wait for a while before starting the next set.\nThis is \"bursty\" instead of \"smooth\".\n\n**Slicing**\n\nReindex supports sliced scroll to parallelize the reindexing process.\nThis parallelization can improve efficiency and provide a convenient way to break the request down into smaller parts.\n\nNOTE: Reindexing from remote clusters does not support manual or automatic slicing.\n\nYou can slice a reindex request manually by providing a slice ID and total number of slices to each request.\nYou can also let reindex automatically parallelize by using sliced scroll to slice on `_id`.\nThe `slices` parameter specifies the number of slices to use.\n\nAdding `slices` to the reindex request just automates the manual process, creating sub-requests which means it has some quirks:\n\n* You can see these requests in the tasks API. These sub-requests are \"child\" tasks of the task for the request with slices.\n* Fetching the status of the task for the request with `slices` only contains the status of completed slices.\n* These sub-requests are individually addressable for things like cancellation and rethrottling.\n* Rethrottling the request with `slices` will rethrottle the unfinished sub-request proportionally.\n* Canceling the request with `slices` will cancel each sub-request.\n* Due to the nature of `slices`, each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution.\n* Parameters like `requests_per_second` and `max_docs` on a request with `slices` are distributed proportionally to each sub-request. Combine that with the previous point about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being reindexed.\n* Each sub-request gets a slightly different snapshot of the source, though these are all taken at approximately the same time.\n\nIf slicing automatically, setting `slices` to `auto` will choose a reasonable number for most indices.\nIf slicing manually or otherwise tuning automatic slicing, use the following guidelines.\n\nQuery performance is most efficient when the number of slices is equal to the number of shards in the index.\nIf that number is large (for example, `500`), choose a lower number as too many slices will hurt performance.\nSetting slices higher than the number of shards generally does not improve efficiency and adds overhead.\n\nIndexing performance scales linearly across available resources with the number of slices.\n\nWhether query or indexing performance dominates the runtime depends on the documents being reindexed and cluster resources.\n\n**Modify documents during reindexing**\n\nLike `_update_by_query`, reindex operations support a script that modifies the document.\nUnlike `_update_by_query`, the script is allowed to modify the document's metadata.\n\nJust as in `_update_by_query`, you can set `ctx.op` to change the operation that is run on the destination.\nFor example, set `ctx.op` to `noop` if your script decides that the document doesn’t have to be indexed in the destination. This \"no operation\" will be reported in the `noop` counter in the response body.\nSet `ctx.op` to `delete` if your script decides that the document must be deleted from the destination.\nThe deletion will be reported in the `deleted` counter in the response body.\nSetting `ctx.op` to anything else will return an error, as will setting any other field in `ctx`.\n\nThink of the possibilities! Just be careful; you are able to change:\n\n* `_id`\n* `_index`\n* `_version`\n* `_routing`\n\nSetting `_version` to `null` or clearing it from the `ctx` map is just like not sending the version in an indexing request.\nIt will cause the document to be overwritten in the destination regardless of the version on the target or the version type you use in the reindex API.\n\n**Reindex from remote**\n\nReindex supports reindexing from a remote Elasticsearch cluster.\nThe `host` parameter must contain a scheme, host, port, and optional path.\nThe `username` and `password` parameters are optional and when they are present the reindex operation will connect to the remote Elasticsearch node using basic authentication.\nBe sure to use HTTPS when using basic authentication or the password will be sent in plain text.\nThere are a range of settings available to configure the behavior of the HTTPS connection.\n\nWhen using Elastic Cloud, it is also possible to authenticate against the remote cluster through the use of a valid API key.\nRemote hosts must be explicitly allowed with the `reindex.remote.whitelist` setting.\nIt can be set to a comma delimited list of allowed remote host and port combinations.\nScheme is ignored; only the host and port are used.\nFor example:\n\n```\nreindex.remote.whitelist: [otherhost:9200, another:9200, 127.0.10.*:9200, localhost:*\"]\n```\n\nThe list of allowed hosts must be configured on any nodes that will coordinate the reindex.\nThis feature should work with remote clusters of any version of Elasticsearch.\nThis should enable you to upgrade from any version of Elasticsearch to the current version by reindexing from a cluster of the old version.\n\nWARNING: Elasticsearch does not support forward compatibility across major versions.\nFor example, you cannot reindex from a 7.x cluster into a 6.x cluster.\n\nTo enable queries sent to older versions of Elasticsearch, the `query` parameter is sent directly to the remote host without validation or modification.\n\nNOTE: Reindexing from remote clusters does not support manual or automatic slicing.\n\nReindexing from a remote server uses an on-heap buffer that defaults to a maximum size of 100mb.\nIf the remote index includes very large documents you'll need to use a smaller batch size.\nIt is also possible to set the socket read timeout on the remote connection with the `socket_timeout` field and the connection timeout with the `connect_timeout` field.\nBoth default to 30 seconds.\n\n**Configuring SSL parameters**\n\nReindex from remote supports configurable SSL settings.\nThese must be specified in the `elasticsearch.yml` file, with the exception of the secure settings, which you add in the Elasticsearch keystore.\nIt is not possible to configure SSL in the body of the reindex request.", "docId": "docs-reindex", "docTag": "document", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-reindex.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-reindex", "name": "reindex", "privileges": { "index": [ @@ -15072,7 +15072,7 @@ "description": "Throttle a reindex operation.\n\nChange the number of requests per second for a particular reindex operation.\nFor example:\n\n```\nPOST _reindex/r1A2WoRbTwKZ516z6NEs5A:36619/_rethrottle?requests_per_second=-1\n```\n\nRethrottling that speeds up the query takes effect immediately.\nRethrottling that slows down the query will take effect after completing the current batch.\nThis behavior prevents scroll timeouts.", "docId": "docs-reindex", "docTag": "document", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-reindex.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-reindex", "name": "reindex_rethrottle", "request": { "name": "Request", @@ -15108,7 +15108,7 @@ "description": "Render a search template.\n\nRender a search template as a search request body.", "docId": "render-search-template-api", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/render-search-template-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-render-search-template", "name": "render_search_template", "privileges": { "index": [ @@ -15160,7 +15160,7 @@ }, "description": "Delete a rollup job.\n\nA job must be stopped before it can be deleted.\nIf you attempt to delete a started job, an error occurs.\nSimilarly, if you attempt to delete a nonexistent job, an exception occurs.\n\nIMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data.\nThe API does not delete any previously rolled up data.\nThis is by design; a user may wish to roll up a static data set.\nBecause the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data).\nThus the job can be deleted, leaving behind the rolled up data for analysis.\nIf you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index.\nIf the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example:\n\n```\nPOST my_rollup_index/_delete_by_query\n{\n \"query\": {\n \"term\": {\n \"_rollup.id\": \"the_rollup_job_id\"\n }\n }\n}\n```", "docId": "rollup-delete-job", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-delete-job.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-delete-job", "name": "rollup.delete_job", "privileges": { "cluster": [ @@ -15201,7 +15201,7 @@ }, "description": "Get rollup job information.\nGet the configuration, stats, and status of rollup jobs.\n\nNOTE: This API returns only active (both `STARTED` and `STOPPED`) jobs.\nIf a job was created, ran for a while, then was deleted, the API does not return any details about it.\nFor details about a historical rollup job, the rollup capabilities API may be more useful.", "docId": "rollup-get-job", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-get-job.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-jobs", "name": "rollup.get_jobs", "privileges": { "cluster": [ @@ -15248,7 +15248,7 @@ }, "description": "Get the rollup job capabilities.\nGet the capabilities of any rollup jobs that have been configured for a specific index or index pattern.\n\nThis API is useful because a rollup job is often configured to rollup only a subset of fields from the source index.\nFurthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration.\nThis API enables you to inspect an index and determine:\n\n1. Does this index have associated rollup data somewhere in the cluster?\n2. If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live?", "docId": "rollup-get-rollup-caps", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-get-rollup-caps.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-rollup-caps", "name": "rollup.get_rollup_caps", "privileges": { "cluster": [ @@ -15295,7 +15295,7 @@ }, "description": "Get the rollup index capabilities.\nGet the rollup capabilities of all jobs inside of a rollup index.\nA single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine:\n\n* What jobs are stored in an index (or indices specified via a pattern)?\n* What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job?", "docId": "rollup-get-rollup-index-caps", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-get-rollup-index-caps.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-rollup-index-caps", "name": "rollup.get_rollup_index_caps", "privileges": { "index": [ @@ -15336,7 +15336,7 @@ }, "description": "Create a rollup job.\n\nWARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run.\n\nThe rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index.\n\nThere are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group.\n\nJobs are created in a `STOPPED` state. You can start them with the start rollup jobs API.", "docId": "rollup-put-job", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-put-job.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-put-job", "name": "rollup.put_job", "privileges": { "cluster": [ @@ -15381,7 +15381,7 @@ }, "description": "Search rolled-up data.\nThe rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data.\nIt rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query.\n\nThe request body supports a subset of features from the regular search API.\nThe following functionality is not available:\n\n`size`: Because rollups work on pre-aggregated data, no search hits can be returned and so size must be set to zero or omitted entirely.\n`highlighter`, `suggestors`, `post_filter`, `profile`, `explain`: These are similarly disallowed.\n\n**Searching both historical rollup and non-rollup data**\n\nThe rollup search API has the capability to search across both \"live\" non-rollup data and the aggregated rollup data.\nThis is done by simply adding the live indices to the URI. For example:\n\n```\nGET sensor-1,sensor_rollup/_rollup_search\n{\n \"size\": 0,\n \"aggregations\": {\n \"max_temperature\": {\n \"max\": {\n \"field\": \"temperature\"\n }\n }\n }\n}\n```\n\nThe rollup search endpoint does two things when the search runs:\n\n* The original request is sent to the non-rollup index unaltered.\n* A rewritten version of the original request is sent to the rollup index.\n\nWhen the two responses are received, the endpoint rewrites the rollup response and merges the two together.\nDuring the merging process, if there is any overlap in buckets between the two responses, the buckets from the non-rollup index are used.", "docId": "rollup-search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-search.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-rollup-search", "name": "rollup.rollup_search", "request": { "name": "Request", @@ -15421,7 +15421,7 @@ }, "description": "Start rollup jobs.\nIf you try to start a job that does not exist, an exception occurs.\nIf you try to start a job that is already started, nothing happens.", "docId": "rollup-start-job", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-start-job.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-start-job", "name": "rollup.start_job", "privileges": { "cluster": [ @@ -15462,7 +15462,7 @@ }, "description": "Stop rollup jobs.\nIf you try to stop a job that does not exist, an exception occurs.\nIf you try to stop a job that is already stopped, nothing happens.\n\nSince only a stopped job can be deleted, it can be useful to block the API until the indexer has fully stopped.\nThis is accomplished with the `wait_for_completion` query parameter, and optionally a timeout. For example:\n\n```\nPOST _rollup/job/sensor/_stop?wait_for_completion=true&timeout=10s\n```\nThe parameter blocks the API call from returning until either the job has moved to STOPPED or the specified time has elapsed.\nIf the specified time elapses without the job moving to STOPPED, a timeout exception occurs.", "docId": "rollup-stop-job", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/rollup-stop-job.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-stop-job", "name": "rollup.stop_job", "privileges": { "cluster": [ @@ -15544,7 +15544,7 @@ "description": "Run a scrolling search.\n\nIMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).\n\nThe scroll API gets large sets of results from a single scrolling search request.\nTo get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter.\nThe `scroll` parameter indicates how long Elasticsearch should retain the search context for the request.\nThe search response returns a scroll ID in the `_scroll_id` response body parameter.\nYou can then use the scroll ID with the scroll API to retrieve the next batch of results for the request.\nIf the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.\n\nYou can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.\n\nIMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.", "docId": "scroll-api", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/scroll-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-scroll", "extDocId": "scroll-search-results", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/paginate-search-results.html#scroll-search-results", "name": "scroll", @@ -15601,7 +15601,7 @@ }, "description": "Run a search.\n\nGet search hits that match the query defined in the request.\nYou can provide search queries using the `q` query string parameter or the request body.\nIf both are specified, only the query parameter is used.\n\nIf the Elasticsearch security features are enabled, you must have the read index privilege for the target data stream, index, or alias. For cross-cluster search, refer to the documentation about configuring CCS privileges.\nTo search a point in time (PIT) for an alias, you must have the `read` index privilege for the alias's data streams or indices.\n\n**Search slicing**\n\nWhen paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently with the `slice` and `pit` properties.\nBy default the splitting is done first on the shards, then locally on each shard.\nThe local splitting partitions the shard into contiguous ranges based on Lucene document IDs.\n\nFor instance if the number of shards is equal to 2 and you request 4 slices, the slices 0 and 2 are assigned to the first shard and the slices 1 and 3 are assigned to the second shard.\n\nIMPORTANT: The same point-in-time ID should be used for all slices.\nIf different PIT IDs are used, slices can overlap and miss documents.\nThis situation can occur because the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index.", "docId": "search-search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-search.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search", "extDocId": "ccs-privileges", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/remote-clusters-cert.html#remote-clusters-privileges-ccs", "name": "search", @@ -15655,7 +15655,7 @@ }, "description": "Delete a search application.\n\nRemove a search application and its associated alias. Indices attached to the search application are not removed.", "docId": "search-application-delete", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-search-application.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-delete", "name": "search_application.delete", "privileges": { "cluster": [ @@ -15700,7 +15700,7 @@ "description": "Delete a behavioral analytics collection.\nThe associated data stream is also deleted.", "docId": "delete-analytics-collection", "docTag": "analytics", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-analytics-collection.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-delete-behavioral-analytics", "name": "search_application.delete_behavioral_analytics", "request": { "name": "Request", @@ -15736,7 +15736,7 @@ }, "description": "Get search application details.", "docId": "search-application-get", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-search-application.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get", "name": "search_application.get", "privileges": { "cluster": [ @@ -15778,7 +15778,7 @@ "description": "Get behavioral analytics collections.", "docId": "list-analytics-collection", "docTag": "analytics", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/list-analytics-collection.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get-behavioral-analytics", "name": "search_application.get_behavioral_analytics", "request": { "name": "Request", @@ -15820,7 +15820,7 @@ }, "description": "Get search applications.\nGet information about search applications.", "docId": "list-analytics-collection", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/list-analytics-collection.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get-behavioral-analytics", "name": "search_application.list", "privileges": { "cluster": [ @@ -15858,7 +15858,7 @@ "description": "Create a behavioral analytics collection event.", "docId": "behavioral-analytics-collection-event", "docTag": "analytics", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/post-analytics-collection-event.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-post-behavioral-analytics-event", "extDocId": "behavioral-analytics-event-reference", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/behavioral-analytics-event-reference.html", "name": "search_application.post_behavioral_analytics_event", @@ -15899,7 +15899,7 @@ }, "description": "Create or update a search application.", "docId": "search-application-put", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-search-application.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-put", "name": "search_application.put", "privileges": { "cluster": [ @@ -15947,7 +15947,7 @@ "description": "Create a behavioral analytics collection.", "docId": "put-analytics-collection", "docTag": "analytics", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-analytics-collection.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-put-behavioral-analytics", "name": "search_application.put_behavioral_analytics", "request": { "name": "Request", @@ -15980,7 +15980,7 @@ }, "description": "Render a search application query.\nGenerate an Elasticsearch query using the specified query parameters and the search template associated with the search application or a default template if none is specified.\nIf a parameter used in the search template is not specified in `params`, the parameter's default value will be used.\nThe API returns the specific Elasticsearch query that would be generated and run by calling the search application search API.\n\nYou must have `read` privileges on the backing alias of the search application.", "docId": "search-render-query", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-application-render-query.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-render-query", "name": "search_application.render_query", "request": { "name": "Request", @@ -16019,7 +16019,7 @@ }, "description": "Run a search application search.\nGenerate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template.\nUnspecified template parameters are assigned their default values if applicable.", "docId": "search-application-search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-application-search.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-search", "name": "search_application.search", "request": { "name": "Request", @@ -16060,9 +16060,9 @@ "description": "Search a vector tile.\n\nSearch a vector tile for geospatial values.\nBefore using this API, you should be familiar with the Mapbox vector tile specification.\nThe API returns results as a binary mapbox vector tile.\n\nInternally, Elasticsearch translates a vector tile search API request into a search containing:\n\n* A `geo_bounding_box` query on the ``. The query uses the `//` tile as a bounding box.\n* A `geotile_grid` or `geohex_grid` aggregation on the ``. The `grid_agg` parameter determines the aggregation type. The aggregation uses the `//` tile as a bounding box.\n* Optionally, a `geo_bounds` aggregation on the ``. The search only includes this aggregation if the `exact_bounds` parameter is `true`.\n* If the optional parameter `with_labels` is `true`, the internal search will include a dynamic runtime field that calls the `getLabelPosition` function of the geometry doc value. This enables the generation of new point features containing suggested geometry labels, so that, for example, multi-polygons will have only one label.\n\nFor example, Elasticsearch may translate a vector tile search API request with a `grid_agg` argument of `geotile` and an `exact_bounds` argument of `true` into the following search\n\n```\nGET my-index/_search\n{\n \"size\": 10000,\n \"query\": {\n \"geo_bounding_box\": {\n \"my-geo-field\": {\n \"top_left\": {\n \"lat\": -40.979898069620134,\n \"lon\": -45\n },\n \"bottom_right\": {\n \"lat\": -66.51326044311186,\n \"lon\": 0\n }\n }\n }\n },\n \"aggregations\": {\n \"grid\": {\n \"geotile_grid\": {\n \"field\": \"my-geo-field\",\n \"precision\": 11,\n \"size\": 65536,\n \"bounds\": {\n \"top_left\": {\n \"lat\": -40.979898069620134,\n \"lon\": -45\n },\n \"bottom_right\": {\n \"lat\": -66.51326044311186,\n \"lon\": 0\n }\n }\n }\n },\n \"bounds\": {\n \"geo_bounds\": {\n \"field\": \"my-geo-field\",\n \"wrap_longitude\": false\n }\n }\n }\n}\n```\n\nThe API returns results as a binary Mapbox vector tile.\nMapbox vector tiles are encoded as Google Protobufs (PBF). By default, the tile contains three layers:\n\n* A `hits` layer containing a feature for each `` value matching the `geo_bounding_box` query.\n* An `aggs` layer containing a feature for each cell of the `geotile_grid` or `geohex_grid`. The layer only contains features for cells with matching data.\n* A meta layer containing:\n * A feature containing a bounding box. By default, this is the bounding box of the tile.\n * Value ranges for any sub-aggregations on the `geotile_grid` or `geohex_grid`.\n * Metadata for the search.\n\nThe API only returns features that can display at its zoom level.\nFor example, if a polygon feature has no area at its zoom level, the API omits it.\nThe API returns errors as UTF-8 encoded JSON.\n\nIMPORTANT: You can specify several options for this API as either a query parameter or request body parameter.\nIf you specify both parameters, the query parameter takes precedence.\n\n**Grid precision for geotile**\n\nFor a `grid_agg` of `geotile`, you can use cells in the `aggs` layer as tiles for lower zoom levels.\n`grid_precision` represents the additional zoom levels available through these cells. The final precision is computed by as follows: ` + grid_precision`.\nFor example, if `` is 7 and `grid_precision` is 8, then the `geotile_grid` aggregation will use a precision of 15.\nThe maximum final precision is 29.\nThe `grid_precision` also determines the number of cells for the grid as follows: `(2^grid_precision) x (2^grid_precision)`.\nFor example, a value of 8 divides the tile into a grid of 256 x 256 cells.\nThe `aggs` layer only contains features for cells with matching data.\n\n**Grid precision for geohex**\n\nFor a `grid_agg` of `geohex`, Elasticsearch uses `` and `grid_precision` to calculate a final precision as follows: ` + grid_precision`.\n\nThis precision determines the H3 resolution of the hexagonal cells produced by the `geohex` aggregation.\nThe following table maps the H3 resolution for each precision.\nFor example, if `` is 3 and `grid_precision` is 3, the precision is 6.\nAt a precision of 6, hexagonal cells have an H3 resolution of 2.\nIf `` is 3 and `grid_precision` is 4, the precision is 7.\nAt a precision of 7, hexagonal cells have an H3 resolution of 3.\n\n| Precision | Unique tile bins | H3 resolution | Unique hex bins |\tRatio |\n| --------- | ---------------- | ------------- | ----------------| ----- |\n| 1 | 4 | 0 | 122 | 30.5 |\n| 2 | 16 | 0 | 122 | 7.625 |\n| 3 | 64 | 1 | 842 | 13.15625 |\n| 4 | 256 | 1 | 842 | 3.2890625 |\n| 5 | 1024 | 2 | 5882 | 5.744140625 |\n| 6 | 4096 | 2 | 5882 | 1.436035156 |\n| 7 | 16384 | 3 | 41162 | 2.512329102 |\n| 8 | 65536 | 3 | 41162 | 0.6280822754 |\n| 9 | 262144 | 4 | 288122 | 1.099098206 |\n| 10 | 1048576 | 4 | 288122 | 0.2747745514 |\n| 11 | 4194304 | 5 | 2016842 | 0.4808526039 |\n| 12 | 16777216 | 6 | 14117882 | 0.8414913416 |\n| 13 | 67108864 | 6 | 14117882 | 0.2103728354 |\n| 14 | 268435456 | 7 | 98825162 | 0.3681524172 |\n| 15 | 1073741824 | 8 | 691776122 | 0.644266719 |\n| 16 | 4294967296 | 8 | 691776122 | 0.1610666797 |\n| 17 | 17179869184 | 9 | 4842432842 | 0.2818666889 |\n| 18 | 68719476736 | 10 | 33897029882 | 0.4932667053 |\n| 19 | 274877906944 | 11 | 237279209162 | 0.8632167343 |\n| 20 | 1099511627776 | 11 | 237279209162 | 0.2158041836 |\n| 21 | 4398046511104 | 12 | 1660954464122 | 0.3776573213 |\n| 22 | 17592186044416 | 13 | 11626681248842 | 0.6609003122 |\n| 23 | 70368744177664 | 13 | 11626681248842 | 0.165225078 |\n| 24 | 281474976710656 | 14 | 81386768741882 | 0.2891438866 |\n| 25 | 1125899906842620 | 15 | 569707381193162 | 0.5060018015 |\n| 26 | 4503599627370500 | 15 | 569707381193162 | 0.1265004504 |\n| 27 | 18014398509482000 | 15 | 569707381193162 | 0.03162511259 |\n| 28 | 72057594037927900 | 15 | 569707381193162 | 0.007906278149 |\n| 29 | 288230376151712000 | 15 | 569707381193162 | 0.001976569537 |\n\nHexagonal cells don't align perfectly on a vector tile.\nSome cells may intersect more than one vector tile.\nTo compute the H3 resolution for each precision, Elasticsearch compares the average density of hexagonal bins at each resolution with the average density of tile bins at each zoom level.\nElasticsearch uses the H3 resolution that is closest to the corresponding geotile density.", "docId": "search-vector-tile-api", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-vector-tile-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-mvt", "extDocId": "mapbox-vector-tile", - "extDocUrl": "https://github.com/mapbox/vector-tile-spec/blob/master/README.md", + "extDocUrl": "https://github.com/mapbox/vector-tile-spec/blob/{branch}/README.md", "name": "search_mvt", "privileges": { "index": [ @@ -16103,7 +16103,7 @@ "description": "Get the search shards.\n\nGet the indices and shards that a search request would be run against.\nThis information can be useful for working out issues or planning optimizations with routing and shard preferences.\nWhen filtered aliases are used, the filter is returned as part of the `indices` section.\n\nIf the Elasticsearch security features are enabled, you must have the `view_index_metadata` or `manage` index privilege for the target data stream, index, or alias.", "docId": "search-shards", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-shards.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-shards", "name": "search_shards", "privileges": { "index": [ @@ -16153,7 +16153,7 @@ "description": "Run a search with a search template.", "docId": "search-template-api", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-template-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-template", "extDocId": "search-template", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-template.html", "name": "search_template", @@ -16203,7 +16203,7 @@ }, "description": "Get cache statistics.\nGet statistics about the shared cache for partially mounted indices.", "docId": "searchable-snapshots-api-cache-stats", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/searchable-snapshots-api-cache-stats.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-cache-stats", "extDocId": "searchable-snapshots", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/searchable-snapshots.html", "name": "searchable_snapshots.cache_stats", @@ -16248,7 +16248,7 @@ }, "description": "Clear the cache.\nClear indices and data streams from the shared cache for partially mounted indices.", "docId": "searchable-snapshots-api-clear-cache", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/searchable-snapshots-api-clear-cache.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-clear-cache", "extDocId": "searchable-snapshots", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/searchable-snapshots.html", "name": "searchable_snapshots.clear_cache", @@ -16296,7 +16296,7 @@ }, "description": "Mount a snapshot.\nMount a snapshot as a searchable snapshot index.\nDo not use this API for snapshots managed by index lifecycle management (ILM).\nManually mounting ILM-managed snapshots can interfere with ILM processes.", "docId": "searchable-snapshots-api-mount-snapshot", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/searchable-snapshots-api-mount-snapshot.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-mount", "name": "searchable_snapshots.mount", "privileges": { "cluster": [ @@ -16339,7 +16339,7 @@ }, "description": "Get searchable snapshot statistics.", "docId": "searchable-snapshots-api-stats", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/searchable-snapshots-api-stats.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-stats", "name": "searchable_snapshots.stats", "privileges": { "cluster": [ @@ -16389,7 +16389,7 @@ }, "description": "Activate a user profile.\n\nCreate or update a user profile on behalf of another user.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nThe calling application must have either an `access_token` or a combination of `username` and `password` for the user that the profile document is intended for.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nThis API creates or updates a profile document for end users with information that is extracted from the user's authentication object including `username`, `full_name,` `roles`, and the authentication realm.\nFor example, in the JWT `access_token` case, the profile user's `username` is extracted from the JWT token claim pointed to by the `claims.principal` setting of the JWT realm that authenticated the token.\n\nWhen updating a profile document, the API enables the document if it was disabled.\nAny updates do not change existing content for either the `labels` or `data` fields.", "docId": "security-api-activate-user-profile", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-activate-user-profile.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-activate-user-profile", "name": "security.activate_user_profile", "privileges": { "cluster": [ @@ -16433,7 +16433,7 @@ }, "description": "Authenticate a user.\n\nAuthenticates a user and returns information about the authenticated user.\nInclude the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication).\nA successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user.\nIf the user cannot be authenticated, this API returns a 401 status code.", "docId": "security-api-authenticate", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-authenticate.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-authenticate", "name": "security.authenticate", "request": { "name": "Request", @@ -16469,7 +16469,7 @@ }, "description": "Bulk delete roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk delete roles API cannot delete roles that are defined in roles files.", "docId": "security-api-bulk-delete-role", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-bulk-delete-role.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-bulk-delete-role", "name": "security.bulk_delete_role", "privileges": { "cluster": [ @@ -16513,7 +16513,7 @@ }, "description": "Bulk create or update roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk create or update roles API cannot update roles that are defined in roles files.", "docId": "security-api-bulk-put-role", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-bulk-put-role.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-bulk-put-role", "name": "security.bulk_put_role", "privileges": { "cluster": [ @@ -16554,7 +16554,7 @@ }, "description": "Bulk update API keys.\nUpdate the attributes for multiple API keys.\n\nIMPORTANT: It is not possible to use an API key as the authentication credential for this API. To update API keys, the owner user's credentials are required.\n\nThis API is similar to the update API key API but enables you to apply the same update to multiple API keys in one API call. This operation can greatly improve performance over making individual updates.\n\nIt is not possible to update expired or invalidated API keys.\n\nThis API supports updates to API key access scope, metadata and expiration.\nThe access scope of each API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request.\nThe snapshot of the owner's permissions is updated automatically on every call.\n\nIMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change an API key's access scope. This change can occur if the owner user's permissions have changed since the API key was created or last modified.\n\nA successful request returns a JSON structure that contains the IDs of all updated API keys, the IDs of API keys that already had the requested changes and did not require an update, and error details for any failed update.", "docId": "security-api-bulk-update-key", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-bulk-update-api-keys.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-bulk-update-api-keys", "name": "security.bulk_update_api_keys", "privileges": { "cluster": [ @@ -16593,7 +16593,7 @@ }, "description": "Change passwords.\n\nChange the passwords of users in the native realm and built-in users.", "docId": "security-api-change-password", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-change-password.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-change-password", "name": "security.change_password", "request": { "name": "Request", @@ -16640,7 +16640,7 @@ }, "description": "Clear the API key cache.\n\nEvict a subset of all entries from the API key cache.\nThe cache is also automatically cleared on state changes of the security index.", "docId": "security-api-clear-api-key-cache", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-clear-api-key-cache.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-api-key-cache", "name": "security.clear_api_key_cache", "privileges": { "cluster": [ @@ -16681,7 +16681,7 @@ }, "description": "Clear the privileges cache.\n\nEvict privileges from the native application privilege cache.\nThe cache is also automatically cleared for applications that have their privileges updated.", "docId": "security-api-clear-privilege-cache", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-clear-privilege-cache.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-cached-privileges", "name": "security.clear_cached_privileges", "privileges": { "cluster": [ @@ -16721,7 +16721,7 @@ }, "description": "Clear the user cache.\n\nEvict users from the user cache.\nYou can completely clear the cache or evict specific users.\n\nUser credentials are cached in memory on each node to avoid connecting to a remote authentication service or hitting the disk for every incoming request.\nThere are realm settings that you can use to configure the user cache.\nFor more information, refer to the documentation about controlling the user cache.", "docId": "security-api-clear-cache", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-clear-cache.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-cached-realms", "extDocId": "security-user-cache", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/controlling-user-cache.html", "name": "security.clear_cached_realms", @@ -16758,7 +16758,7 @@ }, "description": "Clear the roles cache.\n\nEvict roles from the native role cache.", "docId": "security-api-clear-role-cache", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-clear-role-cache.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-cached-roles", "name": "security.clear_cached_roles", "privileges": { "cluster": [ @@ -16798,7 +16798,7 @@ }, "description": "Clear service account token caches.\n\nEvict a subset of all entries from the service account token caches.\nTwo separate caches exist for service account tokens: one cache for tokens backed by the `service_tokens` file, and another for tokens backed by the `.security` index.\nThis API clears matching entries from both caches.\n\nThe cache for service account tokens backed by the `.security` index is cleared automatically on state changes of the security index.\nThe cache for tokens backed by the `service_tokens` file is cleared automatically on file changes.", "docId": "security-api-clear-service-token-caches", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-clear-service-token-caches.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-cached-service-tokens", "extDocId": "service-accounts", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", "name": "security.clear_cached_service_tokens", @@ -16841,7 +16841,7 @@ }, "description": "Create an API key.\n\nCreate an API key for access without requiring basic authentication.\n\nIMPORTANT: If the credential that is used to authenticate this request is an API key, the derived API key cannot have any privileges.\nIf you specify privileges, the API returns an error.\n\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\n\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.\n\nThe API keys are created by the Elasticsearch API key service, which is automatically enabled.\nTo configure or turn off the API key service, refer to API key service setting documentation.", "docId": "security-api-create-api-key", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-create-api-key.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key", "extDocId": "security-settings-api-keys", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-settings.html#api-key-service-settings", "name": "security.create_api_key", @@ -16883,7 +16883,7 @@ }, "description": "Create a cross-cluster API key.\n\nCreate an API key of the `cross_cluster` type for the API key based remote cluster access.\nA `cross_cluster` API key cannot be used to authenticate through the REST interface.\n\nIMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error.\n\nCross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled.\n\nNOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the `access` property.\n\nA successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds.\n\nBy default, API keys never expire. You can specify expiration information when you create the API keys.\n\nCross-cluster API keys can only be updated with the update cross-cluster API key API.\nAttempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error.", "docId": "security-api-cross-cluster-key", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-create-cross-cluster-api-key.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-cross-cluster-api-key", "extDocId": "remote-clusters-api-key", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/remote-clusters-api-key.html", "name": "security.create_cross_cluster_api_key", @@ -16928,7 +16928,7 @@ }, "description": "Create a service account token.\n\nCreate a service accounts token for access without requiring basic authentication.\n\nNOTE: Service account tokens never expire.\nYou must actively delete them if they are no longer needed.", "docId": "security-api-create-service-token", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-create-service-token.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-service-token", "extDocId": "service-accounts", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", "name": "security.create_service_token", @@ -16974,7 +16974,7 @@ }, "description": "Delegate PKI authentication.\n\nThis API implements the exchange of an X509Certificate chain for an Elasticsearch access token.\nThe certificate chain is validated, according to RFC 5280, by sequentially considering the trust configuration of every installed PKI realm that has `delegation.enabled` set to `true`.\nA successfully trusted client certificate is also subject to the validation of the subject distinguished name according to thw `username_pattern` of the respective realm.\n\nThis API is called by smart and trusted proxies, such as Kibana, which terminate the user's TLS session but still want to authenticate the user by using a PKI realm—-​as if the user connected directly to Elasticsearch.\n\nIMPORTANT: The association between the subject public key in the target certificate and the corresponding private key is not validated.\nThis is part of the TLS authentication process and it is delegated to the proxy that calls this API.\nThe proxy is trusted to have performed the TLS authentication and this API translates that authentication into an Elasticsearch access token.", "docId": "security-api-delegate-pki", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-delegate-pki-authentication.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delegate-pki", "extDocId": "pki-realm", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/pki-realm.html", "name": "security.delegate_pki", @@ -17017,7 +17017,7 @@ }, "description": "Delete application privileges.\n\nTo use this API, you must have one of the following privileges:\n\n* The `manage_security` cluster privilege (or a greater privilege such as `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request.", "docId": "security-api-delete-privilege", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-delete-privilege.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-privileges", "extDocId": "security-privileges", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html", "name": "security.delete_privileges", @@ -17059,7 +17059,7 @@ }, "description": "Delete roles.\n\nDelete roles in the native realm.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe delete roles API cannot remove roles that are defined in roles files.", "docId": "security-api-delete-role", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-delete-role.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-role", "name": "security.delete_role", "privileges": { "cluster": [ @@ -17100,7 +17100,7 @@ }, "description": "Delete role mappings.\n\nRole mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe delete role mappings API cannot remove role mappings that are defined in role mapping files.", "docId": "security-api-delete-role-mapping", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-delete-role-mapping.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-role-mapping", "extDocId": "mapping-roles", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-roles.html", "name": "security.delete_role_mapping", @@ -17143,7 +17143,7 @@ }, "description": "Delete service account tokens.\n\nDelete service account tokens for a service in a specified namespace.", "docId": "security-api-delete-service-token", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-delete-service-token.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-service-token", "extDocId": "service-accounts", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", "name": "security.delete_service_token", @@ -17181,7 +17181,7 @@ }, "description": "Delete users.\n\nDelete users from the native realm.", "docId": "security-api-delete-user", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-delete-user.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-user", "name": "security.delete_user", "privileges": { "cluster": [ @@ -17217,7 +17217,7 @@ }, "description": "Disable users.\n\nDisable users in the native realm.\nBy default, when you create users, they are enabled.\nYou can use this API to revoke a user's access to Elasticsearch.", "docId": "security-api-disable-user", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-disable-user.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-disable-user", "name": "security.disable_user", "privileges": { "cluster": [ @@ -17259,7 +17259,7 @@ }, "description": "Disable a user profile.\n\nDisable user profiles so that they are not visible in user profile searches.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nWhen you activate a user profile, its automatically enabled and visible in user profile searches. You can use the disable user profile API to disable a user profile so it’s not visible in these searches.\nTo re-enable a disabled user profile, use the enable user profile API .", "docId": "security-api-disable-user-profile", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-disable-user-profile.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-disable-user-profile", "name": "security.disable_user_profile", "privileges": { "cluster": [ @@ -17296,7 +17296,7 @@ }, "description": "Enable users.\n\nEnable users in the native realm.\nBy default, when you create users, they are enabled.", "docId": "security-api-enable-user", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-enable-user.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-enable-user", "name": "security.enable_user", "privileges": { "cluster": [ @@ -17338,7 +17338,7 @@ }, "description": "Enable a user profile.\n\nEnable user profiles to make them visible in user profile searches.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nWhen you activate a user profile, it's automatically enabled and visible in user profile searches.\nIf you later disable the user profile, you can use the enable user profile API to make the profile visible in these searches again.", "docId": "security-api-enable-user-profile", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-enable-user-profile.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-enable-user-profile", "name": "security.enable_user_profile", "privileges": { "cluster": [ @@ -17376,7 +17376,7 @@ }, "description": "Enroll Kibana.\n\nEnable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.\n\nNOTE: This API is currently intended for internal use only by Kibana.\nKibana uses this API internally to configure itself for communications with an Elasticsearch cluster that already has security features enabled.", "docId": "security-api-kibana-enrollment", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-kibana-enrollment.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-enroll-kibana", "name": "security.enroll_kibana", "request": { "name": "Request", @@ -17411,7 +17411,7 @@ }, "description": "Enroll a node.\n\nEnroll a new node to allow it to join an existing cluster with security features enabled.\n\nThe response contains all the necessary information for the joining node to bootstrap discovery and security related settings so that it can successfully join the cluster.\nThe response contains key and certificate material that allows the caller to generate valid signed certificates for the HTTP layer of all nodes in the cluster.", "docId": "security-api-node-enrollment", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-node-enrollment.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-enroll-node", "name": "security.enroll_node", "request": { "name": "Request", @@ -17450,7 +17450,7 @@ }, "description": "Get API key information.\n\nRetrieves information for one or more API keys.\nNOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.\nIf you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.", "docId": "security-api-get-api-key", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-api-key.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-api-key", "name": "security.get_api_key", "privileges": { "cluster": [ @@ -17492,7 +17492,7 @@ }, "description": "Get builtin privileges.\n\nGet the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "docId": "security-api-get-builtin-privileges", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-builtin-privileges.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-builtin-privileges", "extDocId": "security-privileges", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html", "name": "security.get_builtin_privileges", @@ -17535,7 +17535,7 @@ }, "description": "Get application privileges.\n\nTo use this API, you must have one of the following privileges:\n\n* The `read_security` cluster privilege (or a greater privilege such as `manage_security` or `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request.", "docId": "security-api-get-privileges", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-privileges.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-privileges", "extDocId": "security-privileges", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html", "name": "security.get_privileges", @@ -17589,7 +17589,7 @@ }, "description": "Get roles.\n\nGet roles in the native realm.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe get roles API cannot retrieve roles that are defined in roles files.", "docId": "security-api-get-role", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-role.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-role", "name": "security.get_role", "privileges": { "cluster": [ @@ -17636,7 +17636,7 @@ }, "description": "Get role mappings.\n\nRole mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe get role mappings API cannot retrieve role mappings that are defined in role mapping files.", "docId": "security-api-get-role-mapping", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-role-mapping.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-role-mapping", "extDocId": "mapping-roles", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-roles.html", "name": "security.get_role_mapping", @@ -17685,7 +17685,7 @@ }, "description": "Get service accounts.\n\nGet a list of service accounts that match the provided path parameters.\n\nNOTE: Currently, only the `elastic/fleet-server` service account is available.", "docId": "security-api-get-service-accounts", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-service-accounts.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-service-accounts", "extDocId": "service-accounts", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", "name": "security.get_service_accounts", @@ -17740,7 +17740,7 @@ }, "description": "Get service account credentials.\n\nTo use this API, you must have at least the `read_security` cluster privilege (or a greater privilege such as `manage_service_account` or `manage_security`).\n\nThe response includes service account tokens that were created with the create service account tokens API as well as file-backed tokens from all nodes of the cluster.\n\nNOTE: For tokens backed by the `service_tokens` file, the API collects them from all nodes of the cluster.\nTokens with the same name from different nodes are assumed to be the same token and are only counted once towards the total number of service tokens.", "docId": "security-api-get-service-credentials", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-service-credentials.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-service-credentials", "extDocId": "service-accounts", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", "name": "security.get_service_credentials", @@ -17779,7 +17779,7 @@ }, "description": "Get security index settings.\n\nGet the user-configurable settings for the security internal index (`.security` and associated indices).\nOnly a subset of the index settings — those that are user-configurable—will be shown.\nThis includes:\n\n* `index.auto_expand_replicas`\n* `index.number_of_replicas`", "docId": "security-api-get-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-settings.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-settings", "name": "security.get_settings", "privileges": { "cluster": [ @@ -17823,7 +17823,7 @@ }, "description": "Get a token.\n\nCreate a bearer token for access without requiring basic authentication.\nThe tokens are created by the Elasticsearch Token Service, which is automatically enabled when you configure TLS on the HTTP interface.\nAlternatively, you can explicitly enable the `xpack.security.authc.token.enabled` setting.\nWhen you are running in production mode, a bootstrap check prevents you from enabling the token service unless you also enable TLS on the HTTP interface.\n\nThe get token API takes the same parameters as a typical OAuth 2.0 token API except for the use of a JSON request body.\n\nA successful get token API call returns a JSON structure that contains the access token, the amount of time (seconds) that the token expires in, the type, and the scope if available.\n\nThe tokens returned by the get token API have a finite period of time for which they are valid and after that time period, they can no longer be used.\nThat time period is defined by the `xpack.security.authc.token.timeout` setting.\nIf you want to invalidate a token immediately, you can do so by using the invalidate token API.", "docId": "security-api-get-token", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-token.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-token", "extDocId": "security-encrypt-http", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-basic-setup-https.html#encrypt-http-communication", "name": "security.get_token", @@ -17864,7 +17864,7 @@ }, "description": "Get users.\n\nGet information about users in the native realm and built-in users.", "docId": "security-api-get-user", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-user.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-user", "name": "security.get_user", "privileges": { "cluster": [ @@ -17911,7 +17911,7 @@ }, "description": "Get user privileges.\n\nGet the security privileges for the logged in user.\nAll users can use this API, but only to determine their own privileges.\nTo check the privileges of other users, you must use the run as feature.\nTo check whether a user has a specific list of privileges, use the has privileges API.", "docId": "security-api-get-user-privileges", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-user-privileges.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-user-privileges", "name": "security.get_user_privileges", "request": { "name": "Request", @@ -17947,7 +17947,7 @@ }, "description": "Get a user profile.\n\nGet a user's profile using the unique profile ID.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.", "docId": "security-api-get-user-profile", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-get-user-profile.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-user-profile", "name": "security.get_user_profile", "privileges": { "cluster": [ @@ -17988,7 +17988,7 @@ }, "description": "Grant an API key.\n\nCreate an API key on behalf of another user.\nThis API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API.\nThe caller must have authentication credentials for the user on whose behalf the API key will be created.\nIt is not possible to use this API to create an API key without that user's credentials.\nThe supported user authentication credential types are:\n\n* username and password\n* Elasticsearch access tokens\n* JWTs\n\nThe user, for whom the authentication credentials is provided, can optionally \"run as\" (impersonate) another user.\nIn this case, the API key will be created on behalf of the impersonated user.\n\nThis API is intended be used by applications that need to create and manage API keys for end users, but cannot guarantee that those users have permission to create API keys on their own behalf.\nThe API keys are created by the Elasticsearch API key service, which is automatically enabled.\n\nA successful grant API key API call returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\n\nBy default, API keys never expire. You can specify expiration information when you create the API keys.", "docId": "security-api-grant-api-key", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-grant-api-key.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-grant-api-key", "name": "security.grant_api_key", "privileges": { "cluster": [ @@ -18032,7 +18032,7 @@ }, "description": "Check user privileges.\n\nDetermine whether the specified user has a specified list of privileges.\nAll users can use this API, but only to determine their own privileges.\nTo check the privileges of other users, you must use the run as feature.", "docId": "security-api-has-privileges", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-has-privileges.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-has-privileges", "extDocId": "security-privileges", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html", "name": "security.has_privileges", @@ -18081,7 +18081,7 @@ }, "description": "Check user profile privileges.\n\nDetermine whether the users associated with the specified user profile IDs have all the requested privileges.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.", "docId": "security-api-has-privileges-profile", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-has-privileges-user-profile.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-has-privileges-user-profile", "extDocId": "user-profile", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/user-profile.html", "name": "security.has_privileges_user_profile", @@ -18128,7 +18128,7 @@ }, "description": "Invalidate API keys.\n\nThis API invalidates API keys created by the create API key or grant API key APIs.\nInvalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted.\n\nTo use this API, you must have at least the `manage_security`, `manage_api_key`, or `manage_own_api_key` cluster privileges.\nThe `manage_security` privilege allows deleting any API key, including both REST and cross cluster API keys.\nThe `manage_api_key` privilege allows deleting any REST API key, but not cross cluster API keys.\nThe `manage_own_api_key` only allows deleting REST API keys that are owned by the user.\nIn addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:\n\n- Set the parameter `owner=true`.\n- Or, set both `username` and `realm_name` to match the user's identity.\n- Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the `ids` field.", "docId": "security-api-invalidate-api-key", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-invalidate-api-key.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-invalidate-api-key", "name": "security.invalidate_api_key", "privileges": { "cluster": [ @@ -18173,7 +18173,7 @@ }, "description": "Invalidate a token.\n\nThe access tokens returned by the get token API have a finite period of time for which they are valid.\nAfter that time period, they can no longer be used.\nThe time period is defined by the `xpack.security.authc.token.timeout` setting.\n\nThe refresh tokens returned by the get token API are only valid for 24 hours.\nThey can also be used exactly once.\nIf you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API.\n\nNOTE: While all parameters are optional, at least one of them is required.\nMore specifically, either one of `token` or `refresh_token` parameters is required.\nIf none of these two are specified, then `realm_name` and/or `username` need to be specified.", "docId": "security-api-invalidate-token", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-invalidate-token.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-invalidate-token", "name": "security.invalidate_token", "request": { "name": "Request", @@ -18208,7 +18208,7 @@ }, "description": "Authenticate OpenID Connect.\n\nExchange an OpenID Connect authentication response message for an Elasticsearch internal access token and refresh token that can be subsequently used for authentication.\n\nElasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs.\nThese APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.", "docId": "security-api-oidc-authenticate", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-oidc-authenticate.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-oidc-authenticate", "name": "security.oidc_authenticate", "request": { "name": "Request", @@ -18243,7 +18243,7 @@ }, "description": "Logout of OpenID Connect.\n\nInvalidate an access token and a refresh token that were generated as a response to the `/_security/oidc/authenticate` API.\n\nIf the OpenID Connect authentication realm in Elasticsearch is accordingly configured, the response to this call will contain a URI pointing to the end session endpoint of the OpenID Connect Provider in order to perform single logout.\n\nElasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs.\nThese APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.", "docId": "security-api-oidc-logout", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-oidc-logout.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-oidc-logout", "name": "security.oidc_logout", "request": { "name": "Request", @@ -18278,7 +18278,7 @@ }, "description": "Prepare OpenID connect authentication.\n\nCreate an oAuth 2.0 authentication request as a URL string based on the configuration of the OpenID Connect authentication realm in Elasticsearch.\n\nThe response of this API is a URL pointing to the Authorization Endpoint of the configured OpenID Connect Provider, which can be used to redirect the browser of the user in order to continue the authentication process.\n\nElasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs.\nThese APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.", "docId": "security-api-oidc-prepare", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-oidc-prepare-authentication.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-oidc-prepare-authentication", "name": "security.oidc_prepare_authentication", "request": { "name": "Request", @@ -18317,7 +18317,7 @@ }, "description": "Create or update application privileges.\n\nTo use this API, you must have one of the following privileges:\n\n* The `manage_security` cluster privilege (or a greater privilege such as `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request.\n\nApplication names are formed from a prefix, with an optional suffix that conform to the following rules:\n\n* The prefix must begin with a lowercase ASCII letter.\n* The prefix must contain only ASCII letters or digits.\n* The prefix must be at least 3 characters long.\n* If the suffix exists, it must begin with either a dash `-` or `_`.\n* The suffix cannot contain any of the following characters: `\\`, `/`, `*`, `?`, `\"`, `<`, `>`, `|`, `,`, `*`.\n* No part of the name can contain whitespace.\n\nPrivilege names must begin with a lowercase ASCII letter and must contain only ASCII letters and digits along with the characters `_`, `-`, and `.`.\n\nAction names can contain any number of printable ASCII characters and must contain at least one of the following characters: `/`, `*`, `:`.", "docId": "security-api-put-privileges", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-put-privileges.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-privileges", "extDocId": "security-privileges", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html", "name": "security.put_privileges", @@ -18363,7 +18363,7 @@ }, "description": "Create or update roles.\n\nThe role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management.\nThe create or update roles API cannot update roles that are defined in roles files.\nFile-based role management is not available in Elastic Serverless.", "docId": "security-api-put-role", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-put-role.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-role", "extDocId": "defining-roles", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/defining-roles.html", "name": "security.put_role", @@ -18410,7 +18410,7 @@ }, "description": "Create or update role mappings.\n\nRole mappings define which roles are assigned to each user.\nEach mapping has rules that identify users and a list of roles that are granted to those users.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files.\n\nNOTE: This API does not create roles. Rather, it maps users to existing roles.\nRoles can be created by using the create or update roles API or roles files.\n\n**Role templates**\n\nThe most common use for role mappings is to create a mapping from a known value on the user to a fixed role name.\nFor example, all users in the `cn=admin,dc=example,dc=com` LDAP group should be given the superuser role in Elasticsearch.\nThe `roles` field is used for this purpose.\n\nFor more complex needs, it is possible to use Mustache templates to dynamically determine the names of the roles that should be granted to the user.\nThe `role_templates` field is used for this purpose.\n\nNOTE: To use role templates successfully, the relevant scripting feature must be enabled.\nOtherwise, all attempts to create a role mapping with role templates fail.\n\nAll of the user fields that are available in the role mapping rules are also available in the role templates.\nThus it is possible to assign a user to a role that reflects their username, their groups, or the name of the realm to which they authenticated.\n\nBy default a template is evaluated to produce a single string that is the name of the role which should be assigned to the user.\nIf the format of the template is set to \"json\" then the template is expected to produce a JSON string or an array of JSON strings for the role names.", "docId": "security-api-put-role-mapping", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-put-role-mapping.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-role-mapping", "extDocId": "mapping-roles", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-roles.html", "name": "security.put_role_mapping", @@ -18452,7 +18452,7 @@ }, "description": "Create or update users.\n\nAdd and update users in the native realm.\nA password is required for adding a new user but is optional when updating an existing user.\nTo change a user's password without updating any other fields, use the change password API.", "docId": "security-api-put-user", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-put-user.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-user", "name": "security.put_user", "privileges": { "cluster": [ @@ -18497,7 +18497,7 @@ }, "description": "Find API keys with a query.\n\nGet a paginated list of API keys and their information.\nYou can optionally filter the results with a query.\n\nTo use this API, you must have at least the `manage_own_api_key` or the `read_security` cluster privileges.\nIf you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.\nIf you have the `read_security`, `manage_api_key`, or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.", "docId": "security-api-query-api-key", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-query-api-key.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-query-api-keys", "name": "security.query_api_keys", "privileges": { "cluster": [ @@ -18543,7 +18543,7 @@ }, "description": "Find roles with a query.\n\nGet roles in a paginated manner.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe query roles API does not retrieve roles that are defined in roles files, nor built-in ones.\nYou can optionally filter the results with a query.\nAlso, the results can be paginated and sorted.", "docId": "security-api-query-role", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-query-role.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-query-role", "name": "security.query_role", "privileges": { "cluster": [ @@ -18588,7 +18588,7 @@ }, "description": "Find users with a query.\n\nGet information for users in a paginated manner.\nYou can optionally filter the results with a query.\n\nNOTE: As opposed to the get user API, built-in users are excluded from the result.\nThis API is only for native users.", "docId": "security-api-query-user", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-query-user.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-query-user", "name": "security.query_user", "privileges": { "cluster": [ @@ -18633,7 +18633,7 @@ }, "description": "Authenticate SAML.\n\nSubmit a SAML response message to Elasticsearch for consumption.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThe SAML message that is submitted can be:\n\n* A response to a SAML authentication request that was previously created using the SAML prepare authentication API.\n* An unsolicited SAML message in the case of an IdP-initiated single sign-on (SSO) flow.\n\nIn either case, the SAML message needs to be a base64 encoded XML document with a root element of ``.\n\nAfter successful validation, Elasticsearch responds with an Elasticsearch internal access token and refresh token that can be subsequently used for authentication.\nThis API endpoint essentially exchanges SAML responses that indicate successful authentication in the IdP for Elasticsearch access and refresh tokens, which can be used for authentication against Elasticsearch.", "docId": "security-api-saml-authenticate", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-saml-authenticate.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-authenticate", "extDocId": "security-saml-guide", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/saml-guide-stack.html", "name": "security.saml_authenticate", @@ -18674,7 +18674,7 @@ }, "description": "Logout of SAML completely.\n\nVerifies the logout response sent from the SAML IdP.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThe SAML IdP may send a logout response back to the SP after handling the SP-initiated SAML Single Logout.\nThis API verifies the response by ensuring the content is relevant and validating its signature.\nAn empty response is returned if the verification process is successful.\nThe response can be sent by the IdP with either the HTTP-Redirect or the HTTP-Post binding.\nThe caller of this API must prepare the request accordingly so that this API can handle either of them.", "docId": "security-api-saml-complete-logout", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-saml-complete-logout.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-complete-logout", "extDocId": "security-saml-guide", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/saml-guide-stack.html", "name": "security.saml_complete_logout", @@ -18715,7 +18715,7 @@ }, "description": "Invalidate SAML.\n\nSubmit a SAML LogoutRequest message to Elasticsearch for consumption.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThe logout request comes from the SAML IdP during an IdP initiated Single Logout.\nThe custom web application can use this API to have Elasticsearch process the `LogoutRequest`.\nAfter successful validation of the request, Elasticsearch invalidates the access token and refresh token that corresponds to that specific SAML principal and provides a URL that contains a SAML LogoutResponse message.\nThus the user can be redirected back to their IdP.", "docId": "security-api-saml-invalidate", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-saml-invalidate.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-invalidate", "extDocId": "security-saml-guide", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/saml-guide-stack.html", "name": "security.saml_invalidate", @@ -18756,7 +18756,7 @@ }, "description": "Logout of SAML.\n\nSubmits a request to invalidate an access token and refresh token.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThis API invalidates the tokens that were generated for a user by the SAML authenticate API.\nIf the SAML realm in Elasticsearch is configured accordingly and the SAML IdP supports this, the Elasticsearch response contains a URL to redirect the user to the IdP that contains a SAML logout request (starting an SP-initiated SAML Single Logout).", "docId": "security-api-saml-logout", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-saml-logout.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-logout", "extDocId": "security-saml-guide", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/saml-guide-stack.html", "name": "security.saml_logout", @@ -18797,7 +18797,7 @@ }, "description": "Prepare SAML authentication.\n\nCreate a SAML authentication request (``) as a URL string based on the configuration of the respective SAML realm in Elasticsearch.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThis API returns a URL pointing to the SAML Identity Provider.\nYou can use the URL to redirect the browser of the user in order to continue the authentication process.\nThe URL includes a single parameter named `SAMLRequest`, which contains a SAML Authentication request that is deflated and Base64 encoded.\nIf the configuration dictates that SAML authentication requests should be signed, the URL has two extra parameters named `SigAlg` and `Signature`.\nThese parameters contain the algorithm used for the signature and the signature value itself.\nIt also returns a random string that uniquely identifies this SAML Authentication request.\nThe caller of this API needs to store this identifier as it needs to be used in a following step of the authentication process.", "docId": "security-api-saml-prepare-authentication", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-saml-prepare-authentication.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-prepare-authentication", "extDocId": "security-saml-guide", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/saml-guide-stack.html", "name": "security.saml_prepare_authentication", @@ -18838,7 +18838,7 @@ }, "description": "Create SAML service provider metadata.\n\nGenerate SAML metadata for a SAML 2.0 Service Provider.\n\nThe SAML 2.0 specification provides a mechanism for Service Providers to describe their capabilities and configuration using a metadata file.\nThis API generates Service Provider metadata based on the configuration of a SAML realm in Elasticsearch.", "docId": "security-api-saml-sp-metadata", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-saml-sp-metadata.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-service-provider-metadata", "name": "security.saml_service_provider_metadata", "request": { "name": "Request", @@ -18877,7 +18877,7 @@ }, "description": "Suggest a user profile.\n\nGet suggestions for user profiles that match specified search criteria.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.", "docId": "security-api-suggest", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-suggest-user-profile.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-suggest-user-profiles", "name": "security.suggest_user_profiles", "privileges": { "cluster": [ @@ -18922,7 +18922,7 @@ }, "description": "Update an API key.\n\nUpdate attributes of an existing API key.\nThis API supports updates to an API key's access scope, expiration, and metadata.\n\nTo use this API, you must have at least the `manage_own_api_key` cluster privilege.\nUsers can only update API keys that they created or that were granted to them.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\n\nIMPORTANT: It's not possible to use an API key as the authentication credential for this API. The owner user’s credentials are required.\n\nUse this API to update API keys created by the create API key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use the bulk update API keys API to reduce overhead.\nIt's not possible to update expired API keys or API keys that have been invalidated by the invalidate API key API.\n\nThe access scope of an API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request.\nThe snapshot of the owner's permissions is updated automatically on every call.\n\nIMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change the API key's access scope.\nThis change can occur if the owner user's permissions have changed since the API key was created or last modified.", "docId": "security-api-update-key", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-update-api-key.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-api-key", "name": "security.update_api_key", "privileges": { "cluster": [ @@ -18961,7 +18961,7 @@ }, "description": "Update a cross-cluster API key.\n\nUpdate the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access.\n\nTo use this API, you must have at least the `manage_security` cluster privilege.\nUsers can only update API keys that they created.\nTo update another user's API key, use the `run_as` feature to submit a request on behalf of another user.\n\nIMPORTANT: It's not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user's credentials are required.\n\nIt's not possible to update expired API keys, or API keys that have been invalidated by the invalidate API key API.\n\nThis API supports updates to an API key's access scope, metadata, and expiration.\nThe owner user's information, such as the `username` and `realm`, is also updated automatically on every call.\n\nNOTE: This API cannot update REST API keys, which should be updated by either the update API key or bulk update API keys API.", "docId": "security-api-cross-cluster-key-update", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-update-cross-cluster-api-key.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-cross-cluster-api-key", "extDocId": "remote-clusters-api-key", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/remote-clusters-api-key.html", "name": "security.update_cross_cluster_api_key", @@ -19003,7 +19003,7 @@ }, "description": "Update security index settings.\n\nUpdate the user-configurable settings for the security internal index (`.security` and associated indices). Only a subset of settings are allowed to be modified. This includes `index.auto_expand_replicas` and `index.number_of_replicas`.\n\nNOTE: If `index.auto_expand_replicas` is set, `index.number_of_replicas` will be ignored during updates.\n\nIf a specific index is not in use on the system and settings are provided for it, the request will be rejected.\nThis API does not yet support configuring the settings for indices before they are in use.", "docId": "security-api-update-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-update-settings.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-settings", "name": "security.update_settings", "privileges": { "cluster": [ @@ -19047,7 +19047,7 @@ }, "description": "Update user profile data.\n\nUpdate specific data for the user profile that is associated with a unique ID.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nTo use this API, you must have one of the following privileges:\n\n* The `manage_user_profile` cluster privilege.\n* The `update_profile_data` global privilege for the namespaces that are referenced in the request.\n\nThis API updates the `labels` and `data` fields of an existing user profile document with JSON objects.\nNew keys and their values are added to the profile document and conflicting keys are replaced by data that's included in the request.\n\nFor both labels and data, content is namespaced by the top-level fields.\nThe `update_profile_data` global privilege grants privileges for updating only the allowed namespaces.", "docId": "security-api-update-user-data", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-update-user-profile-data.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-user-profile-data", "name": "security.update_user_profile_data", "privileges": { "cluster": [ @@ -19088,7 +19088,7 @@ }, "description": "Cancel node shutdown preparations.\nRemove a node from the shutdown list so it can resume normal operations.\nYou must explicitly clear the shutdown request when a node rejoins the cluster or when a node has permanently left the cluster.\nShutdown requests are never removed automatically by Elasticsearch.\n\nNOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes.\nDirect use is not supported.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.", "docId": "nodes-api-shutdown-delete", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-shutdown.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-shutdown-delete-node", "name": "shutdown.delete_node", "privileges": { "cluster": [ @@ -19128,7 +19128,7 @@ }, "description": "Get the shutdown status.\n\nGet information about nodes that are ready to be shut down, have shut down preparations still in progress, or have stalled.\nThe API returns status information for each part of the shut down process.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.", "docId": "nodes-api-shutdown-status", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-shutdown.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-shutdown-get-node", "name": "shutdown.get_node", "privileges": { "cluster": [ @@ -19174,7 +19174,7 @@ }, "description": "Prepare a node to be shut down.\n\nNOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nIf you specify a node that is offline, it will be prepared for shut down when it rejoins the cluster.\n\nIf the operator privileges feature is enabled, you must be an operator to use this API.\n\nThe API migrates ongoing tasks and index shards to other nodes as needed to prepare a node to be restarted or shut down and removed from the cluster.\nThis ensures that Elasticsearch can be stopped safely with minimal disruption to the cluster.\n\nYou must specify the type of shutdown: `restart`, `remove`, or `replace`.\nIf a node is already being prepared for shutdown, you can use this API to change the shutdown type.\n\nIMPORTANT: This API does NOT terminate the Elasticsearch process.\nMonitor the node shutdown status to determine when it is safe to stop Elasticsearch.", "docId": "nodes-api-shutdown", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-shutdown.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-shutdown-put-node", "name": "shutdown.put_node", "privileges": { "cluster": [ @@ -19216,7 +19216,7 @@ "description": "Simulate data ingestion.\nRun ingest pipelines against a set of provided documents, optionally with substitute pipeline definitions, to simulate ingesting data into an index.\n\nThis API is meant to be used for troubleshooting or pipeline development, as it does not actually index any data into Elasticsearch.\n\nThe API runs the default and final pipeline for that index against a set of documents provided in the body of the request.\nIf a pipeline contains a reroute processor, it follows that reroute processor to the new index, running that index's pipelines as well the same way that a non-simulated ingest would.\nNo data is indexed into Elasticsearch.\nInstead, the transformed document is returned, along with the list of pipelines that have been run and the name of the index where the document would have been indexed if this were not a simulation.\nThe transformed document is validated against the mappings that would apply to this index, and any validation error is reported in the result.\n\nThis API differs from the simulate pipeline API in that you specify a single pipeline for that API, and it runs only that one pipeline.\nThe simulate pipeline API is more useful for developing a single pipeline, while the simulate ingest API is more useful for troubleshooting the interaction of the various pipelines that get applied when ingesting into an index.\n\nBy default, the pipeline definitions that are currently in the system are used.\nHowever, you can supply substitute pipeline definitions in the body of the request.\nThese will be used in place of the pipeline definitions that are already in the system. This can be used to replace existing pipeline definitions or to create new ones. The pipeline substitutions are used only within this request.", "docId": "simulate-ingest-api", "docTag": "ingest", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/simulate-ingest-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-simulate-ingest", "name": "simulate.ingest", "privileges": { "index": [ @@ -19268,7 +19268,7 @@ }, "description": "Delete a policy.\nDelete a snapshot lifecycle policy definition.\nThis operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots.", "docId": "slm-api-delete-policy", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-delete-policy.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-delete-lifecycle", "name": "slm.delete_lifecycle", "privileges": { "cluster": [ @@ -19309,7 +19309,7 @@ }, "description": "Run a policy.\nImmediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time.\nThe snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance.", "docId": "slm-api-execute-lifecycle", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-execute-lifecycle.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-execute-lifecycle", "name": "slm.execute_lifecycle", "privileges": { "cluster": [ @@ -19350,7 +19350,7 @@ }, "description": "Run a retention policy.\nManually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules.\nThe retention policy is normally applied according to its schedule.", "docId": "slm-api-execute-retention", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-execute-retention.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-execute-retention", "name": "slm.execute_retention", "privileges": { "cluster": [ @@ -19391,7 +19391,7 @@ }, "description": "Get policy information.\nGet snapshot lifecycle policy definitions and information about the latest snapshot attempts.", "docId": "slm-api-get-policy", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-get-policy.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-get-lifecycle", "name": "slm.get_lifecycle", "privileges": { "cluster": [ @@ -19438,7 +19438,7 @@ }, "description": "Get snapshot lifecycle management statistics.\nGet global and policy-level statistics about actions taken by snapshot lifecycle management.", "docId": "slm-api-get-stats", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-get-stats.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-get-stats", "name": "slm.get_stats", "privileges": { "cluster": [ @@ -19479,7 +19479,7 @@ }, "description": "Get the snapshot lifecycle management status.", "docId": "slm-api-get-status", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-get-status.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-get-status", "name": "slm.get_status", "privileges": { "cluster": [ @@ -19520,7 +19520,7 @@ }, "description": "Create or update a policy.\nCreate or update a snapshot lifecycle policy.\nIf the policy already exists, this request increments the policy version.\nOnly the latest version of a policy is stored.", "docId": "slm-api-put-policy", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-put-policy.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-put-lifecycle", "name": "slm.put_lifecycle", "privileges": { "cluster": [ @@ -19567,7 +19567,7 @@ }, "description": "Start snapshot lifecycle management.\nSnapshot lifecycle management (SLM) starts automatically when a cluster is formed.\nManually starting SLM is necessary only if it has been stopped using the stop SLM API.", "docId": "slm-api-start", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-start.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-start", "name": "slm.start", "privileges": { "cluster": [ @@ -19608,7 +19608,7 @@ }, "description": "Stop snapshot lifecycle management.\nStop all snapshot lifecycle management (SLM) operations and the SLM plugin.\nThis API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices.\nStopping SLM does not stop any snapshots that are in progress.\nYou can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped.\n\nThe API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped.\nUse the get snapshot lifecycle management status API to see if SLM is running.", "docId": "slm-api-stop", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/slm-api-stop.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-stop", "name": "slm.stop", "request": { "name": "Request", @@ -19644,7 +19644,7 @@ }, "description": "Clean up the snapshot repository.\nTrigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots.", "docId": "snapshot-repo-cleanup", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clean-up-snapshot-repo-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-cleanup-repository", "extDocId": "clean-up-snapshot-repo", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/snapshots-register-repository.html#snapshots-repository-cleanup", "name": "snapshot.cleanup_repository", @@ -19687,7 +19687,7 @@ }, "description": "Clone a snapshot.\nClone part of all of a snapshot into another snapshot in the same repository.", "docId": "snapshot-clone", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clone-snapshot-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-clone", "name": "snapshot.clone", "privileges": { "cluster": [ @@ -19731,7 +19731,7 @@ }, "description": "Create a snapshot.\nTake a snapshot of a cluster or of data streams and indices.", "docId": "snapshot-create-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/create-snapshot-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-create", "extDocId": "snapshot-create", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/snapshots-take-snapshot.html", "name": "snapshot.create", @@ -19778,7 +19778,7 @@ }, "description": "Create or update a snapshot repository.\nIMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters.\nTo register a snapshot repository, the cluster's global metadata must be writeable.\nEnsure there are no cluster blocks (for example, `cluster.blocks.read_only` and `clsuter.blocks.read_only_allow_delete` settings) that prevent write access.\n\nSeveral options for this API can be specified using a query parameter or a request body parameter.\nIf both parameters are specified, only the query parameter is used.", "docId": "snapshot-repo-create", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-snapshot-repo-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-create-repository", "extDocId": "register-repository", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/snapshots-register-repository.html", "name": "snapshot.create_repository", @@ -19824,7 +19824,7 @@ }, "description": "Delete snapshots.", "docId": "snapshot-delete", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-snapshot-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-delete", "name": "snapshot.delete", "privileges": { "cluster": [ @@ -19865,7 +19865,7 @@ }, "description": "Delete snapshot repositories.\nWhen a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots.\nThe snapshots themselves are left untouched and in place.", "docId": "snapshot-repo-delete", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-snapshot-repo-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-delete-repository", "name": "snapshot.delete_repository", "privileges": { "cluster": [ @@ -19906,7 +19906,7 @@ }, "description": "Get snapshot information.\n\nNOTE: The `after` parameter and `next` field enable you to iterate through snapshots with some consistency guarantees regarding concurrent creation or deletion of snapshots.\nIt is guaranteed that any snapshot that exists at the beginning of the iteration and is not concurrently deleted will be seen during the iteration.\nSnapshots concurrently created may be seen during an iteration.", "docId": "snapshot-get", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-snapshot-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-get", "name": "snapshot.get", "privileges": { "cluster": [ @@ -19947,7 +19947,7 @@ }, "description": "Get snapshot repository information.", "docId": "snapshot-repo-get", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-snapshot-repo-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-get-repository", "name": "snapshot.get_repository", "privileges": { "cluster": [ @@ -19991,7 +19991,7 @@ }, "description": "Analyze a snapshot repository.\nAnalyze the performance characteristics and any incorrect behaviour found in a repository.\n\nThe response exposes implementation details of the analysis which may change from version to version.\nThe response body format is therefore not considered stable and may be different in newer versions.\n\nThere are a large number of third-party storage systems available, not all of which are suitable for use as a snapshot repository by Elasticsearch.\nSome storage systems behave incorrectly, or perform poorly, especially when accessed concurrently by multiple clients as the nodes of an Elasticsearch cluster do. This API performs a collection of read and write operations on your repository which are designed to detect incorrect behaviour and to measure the performance characteristics of your storage system.\n\nThe default values for the parameters are deliberately low to reduce the impact of running an analysis inadvertently and to provide a sensible starting point for your investigations.\nRun your first analysis with the default parameter values to check for simple problems.\nIf successful, run a sequence of increasingly large analyses until you encounter a failure or you reach a `blob_count` of at least `2000`, a `max_blob_size` of at least `2gb`, a `max_total_data_size` of at least `1tb`, and a `register_operation_count` of at least `100`.\nAlways specify a generous timeout, possibly `1h` or longer, to allow time for each analysis to run to completion.\nPerform the analyses using a multi-node cluster of a similar size to your production cluster so that it can detect any problems that only arise when the repository is accessed by many nodes at once.\n\nIf the analysis fails, Elasticsearch detected that your repository behaved unexpectedly.\nThis usually means you are using a third-party storage system with an incorrect or incompatible implementation of the API it claims to support.\nIf so, this storage system is not suitable for use as a snapshot repository.\nYou will need to work with the supplier of your storage system to address the incompatibilities that Elasticsearch detects.\n\nIf the analysis is successful, the API returns details of the testing process, optionally including how long each operation took.\nYou can use this information to determine the performance of your storage system.\nIf any operation fails or returns an incorrect result, the API returns an error.\nIf the API returns an error, it may not have removed all the data it wrote to the repository.\nThe error will indicate the location of any leftover data and this path is also recorded in the Elasticsearch logs.\nYou should verify that this location has been cleaned up correctly.\nIf there is still leftover data at the specified location, you should manually remove it.\n\nIf the connection from your client to Elasticsearch is closed while the client is waiting for the result of the analysis, the test is cancelled.\nSome clients are configured to close their connection if no response is received within a certain timeout.\nAn analysis takes a long time to complete so you might need to relax any such client-side timeouts.\nOn cancellation the analysis attempts to clean up the data it was writing, but it may not be able to remove it all.\nThe path to the leftover data is recorded in the Elasticsearch logs.\nYou should verify that this location has been cleaned up correctly.\nIf there is still leftover data at the specified location, you should manually remove it.\n\nIf the analysis is successful then it detected no incorrect behaviour, but this does not mean that correct behaviour is guaranteed.\nThe analysis attempts to detect common bugs but it does not offer 100% coverage.\nAdditionally, it does not test the following:\n\n* Your repository must perform durable writes. Once a blob has been written it must remain in place until it is deleted, even after a power loss or similar disaster.\n* Your repository must not suffer from silent data corruption. Once a blob has been written, its contents must remain unchanged until it is deliberately modified or deleted.\n* Your repository must behave correctly even if connectivity from the cluster is disrupted. Reads and writes may fail in this case, but they must not return incorrect results.\n\nIMPORTANT: An analysis writes a substantial amount of data to your repository and then reads it back again.\nThis consumes bandwidth on the network between the cluster and the repository, and storage space and I/O bandwidth on the repository itself.\nYou must ensure this load does not affect other users of these systems.\nAnalyses respect the repository settings `max_snapshot_bytes_per_sec` and `max_restore_bytes_per_sec` if available and the cluster setting `indices.recovery.max_bytes_per_sec` which you can use to limit the bandwidth they consume.\n\nNOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions.\n\nNOTE: Different versions of Elasticsearch may perform different checks for repository compatibility, with newer versions typically being stricter than older ones.\nA storage system that passes repository analysis with one version of Elasticsearch may fail with a different version.\nThis indicates it behaves incorrectly in ways that the former version did not detect.\nYou must work with the supplier of your storage system to address the incompatibilities detected by the repository analysis API in any version of Elasticsearch.\n\nNOTE: This API may not work correctly in a mixed-version cluster.\n\n*Implementation details*\n\nNOTE: This section of documentation describes how the repository analysis API works in this version of Elasticsearch, but you should expect the implementation to vary between versions. The request parameters and response format depend on details of the implementation so may also be different in newer versions.\n\nThe analysis comprises a number of blob-level tasks, as set by the `blob_count` parameter and a number of compare-and-exchange operations on linearizable registers, as set by the `register_operation_count` parameter.\nThese tasks are distributed over the data and master-eligible nodes in the cluster for execution.\n\nFor most blob-level tasks, the executing node first writes a blob to the repository and then instructs some of the other nodes in the cluster to attempt to read the data it just wrote.\nThe size of the blob is chosen randomly, according to the `max_blob_size` and `max_total_data_size` parameters.\nIf any of these reads fails then the repository does not implement the necessary read-after-write semantics that Elasticsearch requires.\n\nFor some blob-level tasks, the executing node will instruct some of its peers to attempt to read the data before the writing process completes.\nThese reads are permitted to fail, but must not return partial data.\nIf any read returns partial data then the repository does not implement the necessary atomicity semantics that Elasticsearch requires.\n\nFor some blob-level tasks, the executing node will overwrite the blob while its peers are reading it.\nIn this case the data read may come from either the original or the overwritten blob, but the read operation must not return partial data or a mix of data from the two blobs.\nIf any of these reads returns partial data or a mix of the two blobs then the repository does not implement the necessary atomicity semantics that Elasticsearch requires for overwrites.\n\nThe executing node will use a variety of different methods to write the blob.\nFor instance, where applicable, it will use both single-part and multi-part uploads.\nSimilarly, the reading nodes will use a variety of different methods to read the data back again.\nFor instance they may read the entire blob from start to end or may read only a subset of the data.\n\nFor some blob-level tasks, the executing node will cancel the write before it is complete.\nIn this case, it still instructs some of the other nodes in the cluster to attempt to read the blob but all of these reads must fail to find the blob.\n\nLinearizable registers are special blobs that Elasticsearch manipulates using an atomic compare-and-exchange operation.\nThis operation ensures correct and strongly-consistent behavior even when the blob is accessed by multiple nodes at the same time.\nThe detailed implementation of the compare-and-exchange operation on linearizable registers varies by repository type.\nRepository analysis verifies that that uncontended compare-and-exchange operations on a linearizable register blob always succeed.\nRepository analysis also verifies that contended operations either succeed or report the contention but do not return incorrect results.\nIf an operation fails due to contention, Elasticsearch retries the operation until it succeeds.\nMost of the compare-and-exchange operations performed by repository analysis atomically increment a counter which is represented as an 8-byte blob.\nSome operations also verify the behavior on small blobs with sizes other than 8 bytes.", "docId": "analyze-repository", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/repo-analysis-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-repository-analyze", "name": "snapshot.repository_analyze", "privileges": { "cluster": [ @@ -20029,7 +20029,7 @@ }, "description": "Verify the repository integrity.\nVerify the integrity of the contents of a snapshot repository.\n\nThis API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail.\n\nIf you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its `read_only` option to `true`, and use this API to verify its integrity.\nUntil you do so:\n\n* It may not be possible to restore some snapshots from this repository.\n* Searchable snapshots may report errors when searched or may have unassigned shards.\n* Taking snapshots into this repository may fail or may appear to succeed but have created a snapshot which cannot be restored.\n* Deleting snapshots from this repository may fail or may appear to succeed but leave the underlying data on disk.\n* Continuing to write to the repository while it is in an invalid state may causing additional damage to its contents.\n\nIf the API finds any problems with the integrity of the contents of your repository, Elasticsearch will not be able to repair the damage.\nThe only way to bring the repository back into a fully working state after its contents have been damaged is by restoring its contents from a repository backup which was taken before the damage occurred.\nYou must also identify what caused the damage and take action to prevent it from happening again.\n\nIf you cannot restore a repository backup, register a new repository and use this for all future snapshot operations.\nIn some cases it may be possible to recover some of the contents of a damaged repository, either by restoring as many of its snapshots as needed and taking new snapshots of the restored data, or by using the reindex API to copy data from any searchable snapshots mounted from the damaged repository.\n\nAvoid all operations which write to the repository while the verify repository integrity API is running.\nIf something changes the repository contents while an integrity verification is running then Elasticsearch may incorrectly report having detected some anomalies in its contents due to the concurrent writes.\nIt may also incorrectly fail to report some anomalies that the concurrent writes prevented it from detecting.\n\nNOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions.\n\nNOTE: This API may not work correctly in a mixed-version cluster.\n\nThe default values for the parameters of this API are designed to limit the impact of the integrity verification on other activities in your cluster.\nFor instance, by default it will only use at most half of the `snapshot_meta` threads to verify the integrity of each snapshot, allowing other snapshot operations to use the other half of this thread pool.\nIf you modify these parameters to speed up the verification process, you risk disrupting other snapshot-related operations in your cluster.\nFor large repositories, consider setting up a separate single-node Elasticsearch cluster just for running the integrity verification API.\n\nThe response exposes implementation details of the analysis which may change from version to version.\nThe response body format is therefore not considered stable and may be different in newer versions.", "docId": "snapshot-repo-verify-integrity", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/verify-repo-integrity-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-repository-verify-integrity", "name": "snapshot.repository_verify_integrity", "privileges": { "cluster": [ @@ -20070,7 +20070,7 @@ }, "description": "Restore a snapshot.\nRestore a snapshot of a cluster or data streams and indices.\n\nYou can restore a snapshot only to a running cluster with an elected master node.\nThe snapshot repository must be registered and available to the cluster.\nThe snapshot and cluster versions must be compatible.\n\nTo restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks.\n\nBefore you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API:\n\n```\nGET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream\n```\n\nIf no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices.\n\nIf your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot.", "docId": "snapshot-restore-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/restore-snapshot-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-restore", "extDocId": "restore-snapshot", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/snapshots-restore-snapshot.html", "name": "snapshot.restore", @@ -20116,7 +20116,7 @@ }, "description": "Get the snapshot status.\nGet a detailed description of the current state for each shard participating in the snapshot.\n\nNote that this API should be used only to obtain detailed shard-level information for ongoing snapshots.\nIf this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API.\n\nIf you omit the `` request path parameter, the request retrieves information only for currently running snapshots.\nThis usage is preferred.\nIf needed, you can specify `` and `` to retrieve information for specific snapshots, even if they're not currently running.\n\nWARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive.\nThe API requires a read from the repository for each shard in each snapshot.\nFor example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards).\n\nDepending on the latency of your storage, such requests can take an extremely long time to return results.\nThese requests can also tax machine resources and, when using cloud storage, incur high processing costs.", "docId": "snapshot-status", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-snapshot-status-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-status", "name": "snapshot.status", "privileges": { "cluster": [ @@ -20169,7 +20169,7 @@ }, "description": "Verify a snapshot repository.\nCheck for common misconfigurations in a snapshot repository.", "docId": "snapshot-repo-verify", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/verify-snapshot-repo-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-verify-repository", "extDocId": "verify-repository", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/snapshots-register-repository.html#snapshots-repository-verification", "name": "snapshot.verify_repository", @@ -20212,7 +20212,7 @@ }, "description": "Clear an SQL search cursor.", "docId": "sql-clear-cursor-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clear-sql-cursor-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-clear-cursor", "name": "sql.clear_cursor", "request": { "name": "Request", @@ -20251,7 +20251,7 @@ }, "description": "Delete an async SQL search.\nDelete an async SQL search or a stored synchronous SQL search.\nIf the search is still running, the API cancels it.\n\nIf the Elasticsearch security features are enabled, only the following users can use this API to delete a search:\n\n* Users with the `cancel_task` cluster privilege.\n* The user who first submitted the search.", "docId": "sql-delete-async-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-async-sql-search-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-delete-async", "name": "sql.delete_async", "privileges": { "cluster": [ @@ -20292,7 +20292,7 @@ }, "description": "Get async SQL search results.\nGet the current status and available results for an async SQL search or stored synchronous SQL search.\n\nIf the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API.", "docId": "sql-async-search-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-sql-search-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-get-async", "name": "sql.get_async", "request": { "name": "Request", @@ -20328,7 +20328,7 @@ }, "description": "Get the async SQL search status.\nGet the current status of an async SQL search or a stored synchronous SQL search.", "docId": "sql-async-status-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-sql-search-status-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-get-async-status", "name": "sql.get_async_status", "privileges": { "cluster": [ @@ -20369,7 +20369,7 @@ }, "description": "Get SQL search results.\nRun an SQL request.", "docId": "sql-search-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sql-search-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-query", "name": "sql.query", "privileges": { "index": [ @@ -20414,7 +20414,7 @@ }, "description": "Translate SQL into Elasticsearch queries.\nTranslate an SQL search into a search API request containing Query DSL.\nIt accepts the same request body parameters as the SQL search API, excluding `cursor`.", "docId": "sql-translate-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sql-translate-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-translate", "name": "sql.translate", "privileges": { "index": [ @@ -20460,7 +20460,7 @@ "description": "Get SSL certificates.\n\nGet information about the X.509 certificates that are used to encrypt communications in the cluster.\nThe API returns a list that includes certificates from all TLS contexts including:\n\n- Settings for transport and HTTP interfaces\n- TLS settings that are used within authentication realms\n- TLS settings for remote monitoring exporters\n\nThe list includes certificates that are used for configuring trust, such as those configured in the `xpack.security.transport.ssl.truststore` and `xpack.security.transport.ssl.certificate_authorities` settings.\nIt also includes certificates that are used for configuring server identity, such as `xpack.security.http.ssl.keystore` and `xpack.security.http.ssl.certificate settings`.\n\nThe list does not include certificates that are sourced from the default SSL context of the Java Runtime Environment (JRE), even if those certificates are in use within Elasticsearch.\n\nNOTE: When a PKCS#11 token is configured as the truststore of the JRE, the API returns all the certificates that are included in the PKCS#11 token irrespective of whether these are used in the Elasticsearch TLS configuration.\n\nIf Elasticsearch is configured to use a keystore or truststore, the API output includes all certificates in that store, even though some of the certificates might not be in active use within the cluster.", "docId": "security-api-ssl", "docTag": "security", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-ssl.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ssl-certificates", "extDocId": "security-encrypt-internode", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-basic-setup.html#encrypt-internode-communication", "name": "ssl.certificates", @@ -20503,7 +20503,7 @@ }, "description": "Delete a synonym set.\n\nYou can only delete a synonyms set that is not in use by any index analyzer.\n\nSynonyms sets can be used in synonym graph token filters and synonym token filters.\nThese synonym filters can be used as part of search analyzers.\n\nAnalyzers need to be loaded when an index is restored (such as when a node starts, or the index becomes open).\nEven if the analyzer is not used on any field mapping, it still needs to be loaded on the index recovery phase.\n\nIf any analyzers cannot be loaded, the index becomes unavailable and the cluster status becomes red or yellow as index shards are not available.\nTo prevent that, synonyms sets that are used in analyzers can't be deleted.\nA delete request in this case will return a 400 response code.\n\nTo remove a synonyms set, you must first remove all indices that contain analyzers using it.\nYou can migrate an index by creating a new index that does not contain the token filter with the synonyms set, and use the reindex API in order to copy over the index data.\nOnce finished, you can delete the index.\nWhen the synonyms set is not used in analyzers, you will be able to delete it.", "docId": "synonym-set-delete", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-synonyms-set.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-delete-synonym", "name": "synonyms.delete_synonym", "privileges": { "cluster": [ @@ -20544,7 +20544,7 @@ }, "description": "Delete a synonym rule.\nDelete a synonym rule from a synonym set.", "docId": "synonym-rule-delete", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-synonym-rule.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-delete-synonym-rule", "name": "synonyms.delete_synonym_rule", "privileges": { "cluster": [ @@ -20588,7 +20588,7 @@ }, "description": "Get a synonym set.", "docId": "synonym-set-get", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-synonyms-set.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym", "name": "synonyms.get_synonym", "privileges": { "cluster": [ @@ -20629,7 +20629,7 @@ }, "description": "Get a synonym rule.\nGet a synonym rule from a synonym set.", "docId": "synonym-rule-get", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-synonym-rule.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym-rule", "name": "synonyms.get_synonym_rule", "privileges": { "cluster": [ @@ -20673,7 +20673,7 @@ }, "description": "Get all synonym sets.\nGet a summary of all defined synonym sets.", "docId": "synonym-set-list", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-synonyms-set.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym", "name": "synonyms.get_synonyms_sets", "privileges": { "cluster": [ @@ -20714,7 +20714,7 @@ }, "description": "Create or update a synonym set.\nSynonyms sets are limited to a maximum of 10,000 synonym rules per set.\nIf you need to manage more synonym rules, you can create multiple synonym sets.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.", "docId": "synonym-set-create", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-synonyms-set.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-put-synonym", "name": "synonyms.put_synonym", "privileges": { "cluster": [ @@ -20758,7 +20758,7 @@ }, "description": "Create or update a synonym rule.\nCreate or update a synonym rule in a synonym set.\n\nIf any of the synonym rules included is invalid, the API returns an error.\n\nWhen you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule.", "docId": "synonym-rule-create", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-synonym-rule.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-put-synonym-rule", "name": "synonyms.put_synonym_rule", "privileges": { "cluster": [ @@ -20802,7 +20802,7 @@ }, "description": "Cancel a task.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nA task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away.\nIt is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation.\nThe get task information API will continue to list these cancelled tasks until they complete.\nThe cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible.\n\nTo troubleshoot why a cancelled task does not complete promptly, use the get task information API with the `?detailed` parameter to identify the other tasks the system is running.\nYou can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task.", "docId": "tasks", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/tasks.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks", "name": "tasks.cancel", "privileges": { "cluster": [ @@ -20849,7 +20849,7 @@ }, "description": "Get task information.\nGet information about a task currently running in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nIf the task identifier is not found, a 404 response code indicates that there are no resources that match the request.", "docId": "tasks", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/tasks.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks", "name": "tasks.get", "privileges": { "cluster": [ @@ -20890,7 +20890,7 @@ }, "description": "Get all tasks.\nGet information about the tasks currently running on one or more nodes in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\n**Identifying running tasks**\n\nThe `X-Opaque-Id header`, when provided on the HTTP request header, is going to be returned as a header in the response as well as in the headers field for in the task information.\nThis enables you to track certain calls or associate certain tasks with the client that started them.\nFor example:\n\n```\ncurl -i -H \"X-Opaque-Id: 123456\" \"http://localhost:9200/_tasks?group_by=parents\"\n```\n\nThe API returns the following result:\n\n```\nHTTP/1.1 200 OK\nX-Opaque-Id: 123456\ncontent-type: application/json; charset=UTF-8\ncontent-length: 831\n\n{\n \"tasks\" : {\n \"u5lcZHqcQhu-rUoFaqDphA:45\" : {\n \"node\" : \"u5lcZHqcQhu-rUoFaqDphA\",\n \"id\" : 45,\n \"type\" : \"transport\",\n \"action\" : \"cluster:monitor/tasks/lists\",\n \"start_time_in_millis\" : 1513823752749,\n \"running_time_in_nanos\" : 293139,\n \"cancellable\" : false,\n \"headers\" : {\n \"X-Opaque-Id\" : \"123456\"\n },\n \"children\" : [\n {\n \"node\" : \"u5lcZHqcQhu-rUoFaqDphA\",\n \"id\" : 46,\n \"type\" : \"direct\",\n \"action\" : \"cluster:monitor/tasks/lists[n]\",\n \"start_time_in_millis\" : 1513823752750,\n \"running_time_in_nanos\" : 92133,\n \"cancellable\" : false,\n \"parent_task_id\" : \"u5lcZHqcQhu-rUoFaqDphA:45\",\n \"headers\" : {\n \"X-Opaque-Id\" : \"123456\"\n }\n }\n ]\n }\n }\n }\n```\nIn this example, `X-Opaque-Id: 123456` is the ID as a part of the response header.\nThe `X-Opaque-Id` in the task `headers` is the ID for the task that was initiated by the REST request.\nThe `X-Opaque-Id` in the children `headers` is the child task of the task that was initiated by the REST request.", "docId": "tasks", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/tasks.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks", "name": "tasks.list", "privileges": { "cluster": [ @@ -20932,7 +20932,7 @@ "description": "Get terms in an index.\n\nDiscover terms that match a partial string in an index.\nThis API is designed for low-latency look-ups used in auto-complete scenarios.\n\n> info\n> The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.", "docId": "search-terms-enum", "docTag": "search", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-terms-enum.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-terms-enum", "name": "terms_enum", "request": { "name": "Request", @@ -20972,7 +20972,7 @@ "description": "Get term vector information.\n\nGet information and statistics about terms in the fields of a particular document.\n\nYou can retrieve term vectors for documents stored in the index or for artificial documents passed in the body of the request.\nYou can specify the fields you are interested in through the `fields` parameter or by adding the fields to the request body.\nFor example:\n\n```\nGET /my-index-000001/_termvectors/1?fields=message\n```\n\nFields can be specified using wildcards, similar to the multi match query.\n\nTerm vectors are real-time by default, not near real-time.\nThis can be changed by setting `realtime` parameter to `false`.\n\nYou can request three types of values: _term information_, _term statistics_, and _field statistics_.\nBy default, all term information and field statistics are returned for all fields but term statistics are excluded.\n\n**Term information**\n\n* term frequency in the field (always returned)\n* term positions (`positions: true`)\n* start and end offsets (`offsets: true`)\n* term payloads (`payloads: true`), as base64 encoded bytes\n\nIf the requested information wasn't stored in the index, it will be computed on the fly if possible.\nAdditionally, term vectors could be computed for documents not even existing in the index, but instead provided by the user.\n\n> warn\n> Start and end offsets assume UTF-16 encoding is being used. If you want to use these offsets in order to get the original text that produced this token, you should make sure that the string you are taking a sub-string of is also encoded using UTF-16.\n\n**Behaviour**\n\nThe term and field statistics are not accurate.\nDeleted documents are not taken into account.\nThe information is only retrieved for the shard the requested document resides in.\nThe term and field statistics are therefore only useful as relative measures whereas the absolute numbers have no meaning in this context.\nBy default, when requesting term vectors of artificial documents, a shard to get the statistics from is randomly selected.\nUse `routing` only to hit a particular shard.", "docId": "docs-termvectors", "docTag": "document", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-termvectors.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-termvectors", "name": "termvectors", "privileges": { "index": [ @@ -21020,7 +21020,7 @@ }, "description": "Find the structure of a text field.\nFind the structure of a text field in an Elasticsearch index.\n\nThis API provides a starting point for extracting further information from log messages already ingested into Elasticsearch.\nFor example, if you have ingested data into a very simple index that has just `@timestamp` and message fields, you can use this API to see what common structure exists in the message field.\n\nThe response from the API contains:\n\n* Sample messages.\n* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.\n* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.\n* Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.\n\nAll this information can be calculated by the structure finder with no guidance.\nHowever, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.\n\nIf the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response.\nIt helps determine why the returned structure was chosen.", "docId": "find-field-structure", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/find-field-structure.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-text_structure", "name": "text_structure.find_field_structure", "privileges": { "cluster": [ @@ -21057,7 +21057,7 @@ }, "description": "Find the structure of text messages.\nFind the structure of a list of text messages.\nThe messages must contain data that is suitable to be ingested into Elasticsearch.\n\nThis API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality.\nUse this API rather than the find text structure API if your input text has already been split up into separate messages by some other process.\n\nThe response from the API contains:\n\n* Sample messages.\n* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.\n* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.\nAppropriate mappings for an Elasticsearch index, which you could use to ingest the text.\n\nAll this information can be calculated by the structure finder with no guidance.\nHowever, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.\n\nIf the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response.\nIt helps determine why the returned structure was chosen.", "docId": "find-message-structure", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/find-message-structure.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-find-message-structure", "name": "text_structure.find_message_structure", "privileges": { "cluster": [ @@ -21102,7 +21102,7 @@ }, "description": "Find the structure of a text file.\nThe text file must contain data that is suitable to be ingested into Elasticsearch.\n\nThis API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality.\nUnlike other Elasticsearch endpoints, the data that is posted to this endpoint does not need to be UTF-8 encoded and in JSON format.\nIt must, however, be text; binary text formats are not currently supported.\nThe size is limited to the Elasticsearch HTTP receive buffer size, which defaults to 100 Mb.\n\nThe response from the API contains:\n\n* A couple of messages from the beginning of the text.\n* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.\n* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.\n* Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.\n\nAll this information can be calculated by the structure finder with no guidance.\nHowever, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.", "docId": "find-structure", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/find-structure.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-find-structure", "name": "text_structure.find_structure", "privileges": { "cluster": [ @@ -21146,7 +21146,7 @@ }, "description": "Test a Grok pattern.\nTest a Grok pattern on one or more lines of text.\nThe API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings.", "docId": "test-grok-pattern", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/test-grok-pattern.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-test-grok-pattern", "extDocId": "grok", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/grok.html", "name": "text_structure.test_grok_pattern", @@ -21188,7 +21188,7 @@ }, "description": "Delete a transform.", "docId": "delete-transform", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-transform.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-delete-transform", "name": "transform.delete_transform", "privileges": { "cluster": [ @@ -21254,7 +21254,7 @@ }, "description": "Get transforms.\nGet configuration information for transforms.", "docId": "get-transform", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-transform.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-get-transform", "name": "transform.get_transform", "privileges": { "cluster": [ @@ -21301,7 +21301,7 @@ }, "description": "Get transform stats.\nGet usage information for transforms.", "docId": "get-transform-stats", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-transform-stats.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-get-transform-stats", "name": "transform.get_transform_stats", "privileges": { "cluster": [ @@ -21346,7 +21346,7 @@ }, "description": "Preview a transform.\nGenerates a preview of the results that you will get when you create a transform with the same configuration.\n\nIt returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also\ngenerates a list of mappings and settings for the destination index. These values are determined based on the field\ntypes of the source index and the transform aggregations.", "docId": "preview-transform", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/preview-transform.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-preview-transform", "name": "transform.preview_transform", "privileges": { "cluster": [ @@ -21402,7 +21402,7 @@ }, "description": "Create a transform.\nCreates a transform.\n\nA transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as\na data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a\nunique row per entity.\n\nYou must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If\nyou choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in\nthe pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values\nin the latest object.\n\nYou must have `create_index`, `index`, and `read` privileges on the destination index and `read` and\n`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the\ntransform remembers which roles the user that created it had at the time of creation and uses those same roles. If\nthose roles do not have the required privileges on the source and destination indices, the transform fails when it\nattempts unauthorized operations.\n\nNOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any\n`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do\nnot give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not\ngive users any privileges on `.data-frame-internal*` indices.", "docId": "put-transform", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-transform.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-put-transform", "name": "transform.put_transform", "privileges": { "cluster": [ @@ -21452,7 +21452,7 @@ }, "description": "Reset a transform.\nResets a transform.\nBefore you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.", "docId": "reset-transform", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/reset-transform.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-reset-transform", "name": "transform.reset_transform", "privileges": { "cluster": [ @@ -21493,7 +21493,7 @@ }, "description": "Schedule a transform to start now.\nInstantly runs a transform to process data.\n\nIf you _schedule_now a transform, it will process the new data instantly,\nwithout waiting for the configured frequency interval. After _schedule_now API is called,\nthe transform will be processed again at now + frequency unless _schedule_now API\nis called again in the meantime.", "docId": "schedule-now-transform", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/schedule-now-transform.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-schedule-now-transform", "name": "transform.schedule_now_transform", "privileges": { "cluster": [ @@ -21537,7 +21537,7 @@ }, "description": "Start a transform.\nStarts a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", "docId": "start-transform", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/start-transform.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-start-transform", "name": "transform.start_transform", "privileges": { "cluster": [ @@ -21582,7 +21582,7 @@ }, "description": "Stop transforms.\nStops one or more transforms.", "docId": "stop-transform", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/stop-transform.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-stop-transform", "name": "transform.stop_transform", "privileges": { "cluster": [ @@ -21623,7 +21623,7 @@ }, "description": "Update a transform.\nUpdates certain properties of a transform.\n\nAll updated properties except `description` do not take effect until after the transform starts the next checkpoint,\nthus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`\nprivileges for the source indices. You must also have `index` and `read` privileges for the destination index. When\nElasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the\ntime of update and runs with those privileges.", "docId": "update-transform", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-transform.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-update-transform", "name": "transform.update_transform", "privileges": { "cluster": [ @@ -21672,7 +21672,7 @@ }, "description": "Upgrade all transforms.\nTransforms are compatible across minor versions and between supported major versions.\nHowever, over time, the format of transform configuration information may change.\nThis API identifies transforms that have a legacy configuration format and upgrades them to the latest version.\nIt also cleans up the internal data structures that store the transform state and checkpoints.\nThe upgrade does not affect the source and destination indices.\nThe upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged.\n\nIf a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue.\nResolve the issue then re-run the process again.\nA summary is returned when the upgrade is finished.\n\nTo ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster.\nYou may want to perform a recent cluster backup prior to the upgrade.", "docId": "upgrade-transforms", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/upgrade-transforms.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-upgrade-transforms", "name": "transform.upgrade_transforms", "privileges": { "cluster": [ @@ -21716,7 +21716,7 @@ "description": "Update a document.\n\nUpdate a document by running a script or passing a partial document.\n\nIf the Elasticsearch security features are enabled, you must have the `index` or `write` index privilege for the target index or index alias.\n\nThe script can update, delete, or skip modifying the document.\nThe API also supports passing a partial document, which is merged into the existing document.\nTo fully replace an existing document, use the index API.\nThis operation:\n\n* Gets the document (collocated with the shard) from the index.\n* Runs the specified script.\n* Indexes the result.\n\nThe document must still be reindexed, but using this API removes some network roundtrips and reduces chances of version conflicts between the GET and the index operation.\n\nThe `_source` field must be enabled to use this API.\nIn addition to `_source`, you can access the following variables through the `ctx` map: `_index`, `_type`, `_id`, `_version`, `_routing`, and `_now` (the current timestamp).", "docId": "docs-update", "docTag": "document", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-update.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update", "name": "update", "privileges": { "index": [ @@ -21761,7 +21761,7 @@ "description": "Update documents.\nUpdates documents that match the specified query.\nIf no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or alias:\n\n* `read`\n* `index` or `write`\n\nYou can specify the query criteria in the request URI or the request body using the same syntax as the search API.\n\nWhen you submit an update by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and updates matching documents using internal versioning.\nWhen the versions match, the document is updated and the version number is incremented.\nIf a document changes between the time that the snapshot is taken and the update operation is processed, it results in a version conflict and the operation fails.\nYou can opt to count version conflicts instead of halting and returning by setting `conflicts` to `proceed`.\nNote that if you opt to count version conflicts, the operation could attempt to update more documents from the source than `max_docs` until it has successfully updated `max_docs` documents or it has gone through every document in the source query.\n\nNOTE: Documents with a version equal to 0 cannot be updated using update by query because internal versioning does not support 0 as a valid version number.\n\nWhile processing an update by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents.\nA bulk update request is performed for each batch of matching documents.\nAny query or update failures cause the update by query request to fail and the failures are shown in the response.\nAny update requests that completed successfully still stick, they are not rolled back.\n\n**Throttling update requests**\n\nTo control the rate at which update by query issues batches of update operations, you can set `requests_per_second` to any positive decimal number.\nThis pads each batch with a wait time to throttle the rate.\nSet `requests_per_second` to `-1` to turn off throttling.\n\nThrottling uses a wait time between batches so that the internal scroll requests can be given a timeout that takes the request padding into account.\nThe padding time is the difference between the batch size divided by the `requests_per_second` and the time spent writing.\nBy default the batch size is 1000, so if `requests_per_second` is set to `500`:\n\n```\ntarget_time = 1000 / 500 per second = 2 seconds\nwait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds\n```\n\nSince the batch is issued as a single _bulk request, large batch sizes cause Elasticsearch to create many requests and wait before starting the next set.\nThis is \"bursty\" instead of \"smooth\".\n\n**Slicing**\n\nUpdate by query supports sliced scroll to parallelize the update process.\nThis can improve efficiency and provide a convenient way to break the request down into smaller parts.\n\nSetting `slices` to `auto` chooses a reasonable number for most data streams and indices.\nThis setting will use one slice per shard, up to a certain limit.\nIf there are multiple source data streams or indices, it will choose the number of slices based on the index or backing index with the smallest number of shards.\n\nAdding `slices` to `_update_by_query` just automates the manual process of creating sub-requests, which means it has some quirks:\n\n* You can see these requests in the tasks APIs. These sub-requests are \"child\" tasks of the task for the request with slices.\n* Fetching the status of the task for the request with `slices` only contains the status of completed slices.\n* These sub-requests are individually addressable for things like cancellation and rethrottling.\n* Rethrottling the request with `slices` will rethrottle the unfinished sub-request proportionally.\n* Canceling the request with slices will cancel each sub-request.\n* Due to the nature of slices each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution.\n* Parameters like `requests_per_second` and `max_docs` on a request with slices are distributed proportionally to each sub-request. Combine that with the point above about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being updated.\n* Each sub-request gets a slightly different snapshot of the source data stream or index though these are all taken at approximately the same time.\n\nIf you're slicing manually or otherwise tuning automatic slicing, keep in mind that:\n\n* Query performance is most efficient when the number of slices is equal to the number of shards in the index or backing index. If that number is large (for example, 500), choose a lower number as too many slices hurts performance. Setting slices higher than the number of shards generally does not improve efficiency and adds overhead.\n* Update performance scales linearly across available resources with the number of slices.\n\nWhether query or update performance dominates the runtime depends on the documents being reindexed and cluster resources.\n\n**Update the document source**\n\nUpdate by query supports scripts to update the document source.\nAs with the update API, you can set `ctx.op` to change the operation that is performed.\n\nSet `ctx.op = \"noop\"` if your script decides that it doesn't have to make any changes.\nThe update by query operation skips updating the document and increments the `noop` counter.\n\nSet `ctx.op = \"delete\"` if your script decides that the document should be deleted.\nThe update by query operation deletes the document and increments the `deleted` counter.\n\nUpdate by query supports only `index`, `noop`, and `delete`.\nSetting `ctx.op` to anything else is an error.\nSetting any other field in `ctx` is an error.\nThis API enables you to only modify the source of matching documents; you cannot move them.", "docId": "docs-update-by-query", "docTag": "document", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-update-by-query.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update-by-query", "name": "update_by_query", "privileges": { "index": [ @@ -21838,7 +21838,7 @@ }, "description": "Acknowledge a watch.\nAcknowledging a watch enables you to manually throttle the execution of the watch's actions.\n\nThe acknowledgement state of an action is stored in the `status.actions..ack.state` structure.\n\nIMPORTANT: If the specified watch is currently being executed, this API will return an error\nThe reason for this behavior is to prevent overwriting the watch status from a watch execution.\n\nAcknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`.\nThis happens when the condition of the watch is not met (the condition evaluates to false).", "docId": "watcher-api-ack-watch", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-ack-watch.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-ack-watch", "name": "watcher.ack_watch", "privileges": { "cluster": [ @@ -21882,7 +21882,7 @@ }, "description": "Activate a watch.\nA watch can be either active or inactive.", "docId": "watcher-api-activate-watch", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-activate-watch.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-activate-watch", "extDocId": "watcher-works", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/how-watcher-works.html", "name": "watcher.activate_watch", @@ -21921,7 +21921,7 @@ }, "description": "Deactivate a watch.\nA watch can be either active or inactive.", "docId": "watcher-api-deactivate-watch", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-deactivate-watch.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-deactivate-watch", "extDocId": "watcher-works", "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/how-watcher-works.html", "name": "watcher.deactivate_watch", @@ -21960,7 +21960,7 @@ }, "description": "Delete a watch.\nWhen the watch is removed, the document representing the watch in the `.watches` index is gone and it will never be run again.\n\nDeleting a watch does not delete any watch execution records related to this watch from the watch history.\n\nIMPORTANT: Deleting a watch must be done by using only this API.\nDo not delete the watch directly from the `.watches` index using the Elasticsearch delete document API\nWhen Elasticsearch security features are enabled, make sure no write privileges are granted to anyone for the `.watches` index.", "docId": "watcher-api-delete-watch", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-delete-watch.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-delete-watch", "name": "watcher.delete_watch", "privileges": { "cluster": [ @@ -21996,7 +21996,7 @@ }, "description": "Run a watch.\nThis API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes.\n\nFor testing and debugging purposes, you also have fine-grained control on how the watch runs.\nYou can run the watch without running all of its actions or alternatively by simulating them.\nYou can also force execution by ignoring the watch condition and control whether a watch record would be written to the watch history after it runs.\n\nYou can use the run watch API to run watches that are not yet registered by specifying the watch definition inline.\nThis serves as great tool for testing and debugging your watches prior to adding them to Watcher.\n\nWhen Elasticsearch security features are enabled on your cluster, watches are run with the privileges of the user that stored the watches.\nIf your user is allowed to read index `a`, but not index `b`, then the exact same set of rules will apply during execution of a watch.\n\nWhen using the run watch API, the authorization data of the user that called the API will be used as a base, instead of the information who stored the watch.", "docId": "watcher-api-execute-watch", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-execute-watch.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-execute-watch", "name": "watcher.execute_watch", "privileges": { "cluster": [ @@ -22044,7 +22044,7 @@ }, "description": "Get Watcher index settings.\nGet settings for the Watcher internal index (`.watches`).\nOnly a subset of settings are shown, for example `index.auto_expand_replicas` and `index.number_of_replicas`.", "docId": "watcher-api-get-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-get-settings.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-get-settings", "name": "watcher.get_settings", "request": { "name": "Request", @@ -22079,7 +22079,7 @@ }, "description": "Get a watch.", "docId": "watcher-api-get-watch", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-get-watch.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-get-watch", "name": "watcher.get_watch", "privileges": { "cluster": [ @@ -22115,7 +22115,7 @@ }, "description": "Create or update a watch.\nWhen a watch is registered, a new document that represents the watch is added to the `.watches` index and its trigger is immediately registered with the relevant trigger engine.\nTypically for the `schedule` trigger, the scheduler is the trigger engine.\n\nIMPORTANT: You must use Kibana or this API to create a watch.\nDo not add a watch directly to the `.watches` index by using the Elasticsearch index API.\nIf Elasticsearch security features are enabled, do not give users write privileges on the `.watches` index.\n\nWhen you add a watch you can also define its initial active state by setting the *active* parameter.\n\nWhen Elasticsearch security features are enabled, your watch can index or search only on indices for which the user that stored the watch has privileges.\nIf the user is able to read index `a`, but not index `b`, the same will apply when the watch runs.", "docId": "watcher-api-put-watch", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-put-watch.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-put-watch", "name": "watcher.put_watch", "privileges": { "cluster": [ @@ -22156,7 +22156,7 @@ }, "description": "Query watches.\nGet all registered watches in a paginated manner and optionally filter watches by a query.\n\nNote that only the `_id` and `metadata.*` fields are queryable or sortable.", "docId": "watcher-api-query-watches", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-query-watches.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-query-watches", "name": "watcher.query_watches", "privileges": { "cluster": [ @@ -22196,7 +22196,7 @@ }, "description": "Start the watch service.\nStart the Watcher service if it is not already running.", "docId": "watcher-api-start", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-start.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-start", "name": "watcher.start", "privileges": { "cluster": [ @@ -22233,7 +22233,7 @@ }, "description": "Get Watcher statistics.\nThis API always returns basic metrics.\nYou retrieve more metrics by using the metric parameter.", "docId": "watcher-api-stats", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-stats.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-stats", "name": "watcher.stats", "privileges": { "cluster": [ @@ -22275,7 +22275,7 @@ }, "description": "Stop the watch service.\nStop the Watcher service if it is running.", "docId": "watcher-api-stop", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-stop.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-stop", "name": "watcher.stop", "privileges": { "cluster": [ @@ -22312,7 +22312,7 @@ }, "description": "Update Watcher index settings.\nUpdate settings for the Watcher internal index (`.watches`).\nOnly a subset of settings can be modified.\nThis includes `index.auto_expand_replicas` and `index.number_of_replicas`.", "docId": "watcher-api-update-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-update-settings.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-update-settings", "name": "watcher.update_settings", "privileges": { "cluster": [ @@ -22355,7 +22355,7 @@ }, "description": "Get information.\nThe information provided by the API includes:\n\n* Build information including the build number and timestamp.\n* License information about the currently installed license.\n* Feature information for the features that are currently enabled and available under the current license.", "docId": "info-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/info-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-info", "name": "xpack.info", "privileges": { "cluster": [ @@ -22395,7 +22395,7 @@ }, "description": "Get usage information.\nGet information about the features that are currently enabled and available under the current license.\nThe API also provides some usage statistics.", "docId": "usage-api", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/usage-api.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-xpack", "name": "xpack.usage", "privileges": { "cluster": [ @@ -132813,7 +132813,7 @@ { "description": "Name of the target index to create.", "docId": "indices-clone-index", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-clone-index.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-clone", "name": "target", "required": true, "type": { @@ -138081,7 +138081,7 @@ { "description": "Comma-separated list of data streams, indices, and aliases used to limit the request.\nSupports wildcards (`*`).\nBy default, you must explicitly name the indices you using to limit the request.\nTo limit a request using `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to false.\nYou can update this setting in the `elasticsearch.yml` file or using the cluster update settings API.", "docId": "cluster-update-settings", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-update-settings.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings", "name": "index", "required": true, "type": { @@ -163412,7 +163412,7 @@ { "description": "Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node.", "docId": "ml-put-job", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-put-job.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-job", "name": "allow_lazy_open", "required": false, "serverDefault": false, @@ -167936,7 +167936,7 @@ { "description": "A collection of ingest stats for the model across all nodes.\nThe values are summations of the individual node statistics.\nThe format matches the ingest section in the nodes stats API.", "docId": "cluster-nodes-stats", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-stats.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-stats", "name": "ingest", "required": false, "type": { @@ -175175,7 +175175,7 @@ { "description": "A data frame analytics config as described in create data frame analytics\njobs. Note that `id` and `dest` don’t need to be provided in the context of\nthis API.", "docId": "put-dfanalytics", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-dfanalytics.html", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-data-frame-analytics", "name": "config", "required": false, "type": { @@ -198547,7 +198547,7 @@ { "description": "An array of role descriptors for this API key.\nWhen it is not specified or it is an empty array, the API key will have a point in time snapshot of permissions of the authenticated user.\nIf you supply role descriptors, the resultant permissions are an intersection of API keys permissions and the authenticated user's permissions thereby limiting the access scope for API keys.\nThe structure of role descriptor is the same as the request for the create role API.\nFor more details, refer to the create or update roles API.\n\nNOTE: Due to the way in which this permission intersection is calculated, it is not possible to create an API key that is a child of another API key, unless the derived key is created without any privileges.\nIn this case, you must explicitly specify a role descriptor with no privileges.\nThe derived API key can be used for authentication; it will not have authority to call Elasticsearch APIs.", "extDocId": "security-api-put-role", - "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-put-role.html", + "extDocUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-role", "name": "role_descriptors", "required": false, "type": {