diff --git a/docs/reference/cat/alias.asciidoc b/docs/reference/cat/alias.asciidoc index b52cf8f8700f9..b5ab8ad937c1e 100644 --- a/docs/reference/cat/alias.asciidoc +++ b/docs/reference/cat/alias.asciidoc @@ -4,7 +4,7 @@ cat aliases ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs].. diff --git a/docs/reference/cat/allocation.asciidoc b/docs/reference/cat/allocation.asciidoc index efe635f4f3102..a94c1f1959663 100644 --- a/docs/reference/cat/allocation.asciidoc +++ b/docs/reference/cat/allocation.asciidoc @@ -4,7 +4,7 @@ cat allocation ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs].. diff --git a/docs/reference/cat/anomaly-detectors.asciidoc b/docs/reference/cat/anomaly-detectors.asciidoc index 7a5c9115b4677..350917170a5da 100644 --- a/docs/reference/cat/anomaly-detectors.asciidoc +++ b/docs/reference/cat/anomaly-detectors.asciidoc @@ -5,7 +5,7 @@ cat anomaly detectors ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs].. diff --git a/docs/reference/cat/component-templates.asciidoc b/docs/reference/cat/component-templates.asciidoc index 2127edf062f21..4e905173d7dcc 100644 --- a/docs/reference/cat/component-templates.asciidoc +++ b/docs/reference/cat/component-templates.asciidoc @@ -4,7 +4,7 @@ cat component templates ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs].. diff --git a/docs/reference/cat/count.asciidoc b/docs/reference/cat/count.asciidoc index 39c5b5b798d87..7adcd1464dab1 100644 --- a/docs/reference/cat/count.asciidoc +++ b/docs/reference/cat/count.asciidoc @@ -4,7 +4,7 @@ cat count ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs].. diff --git a/docs/reference/cat/datafeeds.asciidoc b/docs/reference/cat/datafeeds.asciidoc index 0771bcf062827..44a2ccd2faa80 100644 --- a/docs/reference/cat/datafeeds.asciidoc +++ b/docs/reference/cat/datafeeds.asciidoc @@ -5,7 +5,7 @@ cat {dfeeds} ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs].. diff --git a/docs/reference/cat/dataframeanalytics.asciidoc b/docs/reference/cat/dataframeanalytics.asciidoc index fbdd42a3b5e9f..4d57160f171bf 100644 --- a/docs/reference/cat/dataframeanalytics.asciidoc +++ b/docs/reference/cat/dataframeanalytics.asciidoc @@ -5,7 +5,7 @@ cat {dfanalytics} ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs].. diff --git a/docs/reference/cat/fielddata.asciidoc b/docs/reference/cat/fielddata.asciidoc index 22c0d532f212a..f11e40263ec2b 100644 --- a/docs/reference/cat/fielddata.asciidoc +++ b/docs/reference/cat/fielddata.asciidoc @@ -4,7 +4,7 @@ cat fielddata ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs].. diff --git a/docs/reference/cat/health.asciidoc b/docs/reference/cat/health.asciidoc index 70e7960b03573..7ffc170ec8515 100644 --- a/docs/reference/cat/health.asciidoc +++ b/docs/reference/cat/health.asciidoc @@ -4,7 +4,7 @@ cat health ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs].. diff --git a/docs/reference/cat/indices.asciidoc b/docs/reference/cat/indices.asciidoc index 12a299b0e51e8..01771847555bb 100644 --- a/docs/reference/cat/indices.asciidoc +++ b/docs/reference/cat/indices.asciidoc @@ -4,7 +4,7 @@ cat indices ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs].. diff --git a/docs/reference/cat/master.asciidoc b/docs/reference/cat/master.asciidoc index 889c44cd9cc70..422651061f021 100644 --- a/docs/reference/cat/master.asciidoc +++ b/docs/reference/cat/master.asciidoc @@ -4,7 +4,7 @@ cat master ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs].. diff --git a/docs/reference/cat/nodeattrs.asciidoc b/docs/reference/cat/nodeattrs.asciidoc index b372fb0b7dd6e..71a63442df522 100644 --- a/docs/reference/cat/nodeattrs.asciidoc +++ b/docs/reference/cat/nodeattrs.asciidoc @@ -4,7 +4,7 @@ cat nodeattrs ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs].. diff --git a/docs/reference/cat/nodes.asciidoc b/docs/reference/cat/nodes.asciidoc index b369a747a1529..591dd63d8ef91 100644 --- a/docs/reference/cat/nodes.asciidoc +++ b/docs/reference/cat/nodes.asciidoc @@ -5,7 +5,7 @@ cat nodes ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs].. diff --git a/docs/reference/cat/pending_tasks.asciidoc b/docs/reference/cat/pending_tasks.asciidoc index 3a97542e0f019..a40eb00b21d0d 100644 --- a/docs/reference/cat/pending_tasks.asciidoc +++ b/docs/reference/cat/pending_tasks.asciidoc @@ -4,7 +4,7 @@ cat pending tasks ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs].. diff --git a/docs/reference/cat/plugins.asciidoc b/docs/reference/cat/plugins.asciidoc index 3efa7c9ea582f..dffbebcada299 100644 --- a/docs/reference/cat/plugins.asciidoc +++ b/docs/reference/cat/plugins.asciidoc @@ -4,7 +4,7 @@ cat plugins ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs].. diff --git a/docs/reference/cat/recovery.asciidoc b/docs/reference/cat/recovery.asciidoc index 192c3e2d65062..cda551fd0a1d0 100644 --- a/docs/reference/cat/recovery.asciidoc +++ b/docs/reference/cat/recovery.asciidoc @@ -4,7 +4,7 @@ cat recovery ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs].. diff --git a/docs/reference/cat/repositories.asciidoc b/docs/reference/cat/repositories.asciidoc index 140bcf8ee7026..7e6283336e17a 100644 --- a/docs/reference/cat/repositories.asciidoc +++ b/docs/reference/cat/repositories.asciidoc @@ -4,7 +4,7 @@ cat repositories ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs].. diff --git a/docs/reference/cat/segments.asciidoc b/docs/reference/cat/segments.asciidoc index 45b1d71a241ab..f7f1df542535e 100644 --- a/docs/reference/cat/segments.asciidoc +++ b/docs/reference/cat/segments.asciidoc @@ -4,7 +4,7 @@ cat segments ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs].. diff --git a/docs/reference/cat/shards.asciidoc b/docs/reference/cat/shards.asciidoc index 8227cd856fd9c..5e77f2ef3360e 100644 --- a/docs/reference/cat/shards.asciidoc +++ b/docs/reference/cat/shards.asciidoc @@ -5,7 +5,7 @@ cat shards ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs].. diff --git a/docs/reference/cat/snapshots.asciidoc b/docs/reference/cat/snapshots.asciidoc index 27fdc6eb486df..1da739b20272f 100644 --- a/docs/reference/cat/snapshots.asciidoc +++ b/docs/reference/cat/snapshots.asciidoc @@ -4,7 +4,7 @@ cat snapshots ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs].. diff --git a/docs/reference/cat/tasks.asciidoc b/docs/reference/cat/tasks.asciidoc index 6745381f6babe..ff654b30de992 100644 --- a/docs/reference/cat/tasks.asciidoc +++ b/docs/reference/cat/tasks.asciidoc @@ -6,7 +6,7 @@ beta::["The cat task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible.",{es-issue}51628] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs].. diff --git a/docs/reference/cat/templates.asciidoc b/docs/reference/cat/templates.asciidoc index 624ae244d6f04..78ff60c663d2f 100644 --- a/docs/reference/cat/templates.asciidoc +++ b/docs/reference/cat/templates.asciidoc @@ -4,7 +4,7 @@ cat templates ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs].. diff --git a/docs/reference/cat/thread_pool.asciidoc b/docs/reference/cat/thread_pool.asciidoc index 7e7d20b77fc75..1d8517f170aed 100644 --- a/docs/reference/cat/thread_pool.asciidoc +++ b/docs/reference/cat/thread_pool.asciidoc @@ -4,7 +4,7 @@ cat thread pool ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs].. diff --git a/docs/reference/cat/trainedmodel.asciidoc b/docs/reference/cat/trainedmodel.asciidoc index 8203e33056aef..cbb3204450bcd 100644 --- a/docs/reference/cat/trainedmodel.asciidoc +++ b/docs/reference/cat/trainedmodel.asciidoc @@ -5,7 +5,7 @@ cat trained model ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs].. diff --git a/docs/reference/cat/transforms.asciidoc b/docs/reference/cat/transforms.asciidoc index 0fc01ade1d09a..caa814a5e3979 100644 --- a/docs/reference/cat/transforms.asciidoc +++ b/docs/reference/cat/transforms.asciidoc @@ -5,7 +5,7 @@ cat transforms ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs].. diff --git a/docs/reference/ccr/apis/auto-follow/delete-auto-follow-pattern.asciidoc b/docs/reference/ccr/apis/auto-follow/delete-auto-follow-pattern.asciidoc index 18cf723901b52..2ad50d68b923a 100644 --- a/docs/reference/ccr/apis/auto-follow/delete-auto-follow-pattern.asciidoc +++ b/docs/reference/ccr/apis/auto-follow/delete-auto-follow-pattern.asciidoc @@ -5,7 +5,7 @@ Delete auto-follow pattern ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. diff --git a/docs/reference/ccr/apis/auto-follow/get-auto-follow-pattern.asciidoc b/docs/reference/ccr/apis/auto-follow/get-auto-follow-pattern.asciidoc index b4fd820088362..951185d14e920 100644 --- a/docs/reference/ccr/apis/auto-follow/get-auto-follow-pattern.asciidoc +++ b/docs/reference/ccr/apis/auto-follow/get-auto-follow-pattern.asciidoc @@ -5,7 +5,7 @@ Get auto-follow pattern ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. diff --git a/docs/reference/ccr/apis/auto-follow/pause-auto-follow-pattern.asciidoc b/docs/reference/ccr/apis/auto-follow/pause-auto-follow-pattern.asciidoc index 2d70b8da92b49..462ee213ed4e4 100644 --- a/docs/reference/ccr/apis/auto-follow/pause-auto-follow-pattern.asciidoc +++ b/docs/reference/ccr/apis/auto-follow/pause-auto-follow-pattern.asciidoc @@ -5,7 +5,7 @@ Pause auto-follow pattern ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. diff --git a/docs/reference/ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc b/docs/reference/ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc index 9b25bf174659c..672a11302fdd5 100644 --- a/docs/reference/ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc +++ b/docs/reference/ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc @@ -5,7 +5,7 @@ Create auto-follow pattern ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. diff --git a/docs/reference/ccr/apis/auto-follow/resume-auto-follow-pattern.asciidoc b/docs/reference/ccr/apis/auto-follow/resume-auto-follow-pattern.asciidoc index 345b5e7645471..d97c41d67c1ea 100644 --- a/docs/reference/ccr/apis/auto-follow/resume-auto-follow-pattern.asciidoc +++ b/docs/reference/ccr/apis/auto-follow/resume-auto-follow-pattern.asciidoc @@ -5,7 +5,7 @@ Resume auto-follow pattern ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. diff --git a/docs/reference/ccr/apis/ccr-apis.asciidoc b/docs/reference/ccr/apis/ccr-apis.asciidoc index 21e859a0bff9d..0decb98197d31 100644 --- a/docs/reference/ccr/apis/ccr-apis.asciidoc +++ b/docs/reference/ccr/apis/ccr-apis.asciidoc @@ -2,7 +2,7 @@ [[ccr-apis]] == {ccr-cap} APIs -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. diff --git a/docs/reference/ccr/apis/follow/get-follow-info.asciidoc b/docs/reference/ccr/apis/follow/get-follow-info.asciidoc index a913e2e2bd153..4c05faa0a7db8 100644 --- a/docs/reference/ccr/apis/follow/get-follow-info.asciidoc +++ b/docs/reference/ccr/apis/follow/get-follow-info.asciidoc @@ -5,7 +5,7 @@ Get follower info ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. diff --git a/docs/reference/ccr/apis/follow/get-follow-stats.asciidoc b/docs/reference/ccr/apis/follow/get-follow-stats.asciidoc index ff0a72a8b234a..29000a98f64b4 100644 --- a/docs/reference/ccr/apis/follow/get-follow-stats.asciidoc +++ b/docs/reference/ccr/apis/follow/get-follow-stats.asciidoc @@ -5,7 +5,7 @@ Get follower stats ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. diff --git a/docs/reference/ccr/apis/follow/post-forget-follower.asciidoc b/docs/reference/ccr/apis/follow/post-forget-follower.asciidoc index b6f397647817c..8a7887072f6a2 100644 --- a/docs/reference/ccr/apis/follow/post-forget-follower.asciidoc +++ b/docs/reference/ccr/apis/follow/post-forget-follower.asciidoc @@ -5,7 +5,7 @@ Forget follower ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. diff --git a/docs/reference/ccr/apis/follow/post-pause-follow.asciidoc b/docs/reference/ccr/apis/follow/post-pause-follow.asciidoc index f5ce00cbfccfb..c49e9a49b56c9 100644 --- a/docs/reference/ccr/apis/follow/post-pause-follow.asciidoc +++ b/docs/reference/ccr/apis/follow/post-pause-follow.asciidoc @@ -5,7 +5,7 @@ Pause follower ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. diff --git a/docs/reference/ccr/apis/follow/post-resume-follow.asciidoc b/docs/reference/ccr/apis/follow/post-resume-follow.asciidoc index 7bca84827be1f..f6da0110d5c24 100644 --- a/docs/reference/ccr/apis/follow/post-resume-follow.asciidoc +++ b/docs/reference/ccr/apis/follow/post-resume-follow.asciidoc @@ -5,7 +5,7 @@ Resume follower ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. diff --git a/docs/reference/ccr/apis/follow/post-unfollow.asciidoc b/docs/reference/ccr/apis/follow/post-unfollow.asciidoc index 933e3c5674469..56b3195e8a134 100644 --- a/docs/reference/ccr/apis/follow/post-unfollow.asciidoc +++ b/docs/reference/ccr/apis/follow/post-unfollow.asciidoc @@ -5,7 +5,7 @@ Unfollow ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. diff --git a/docs/reference/ccr/apis/follow/put-follow.asciidoc b/docs/reference/ccr/apis/follow/put-follow.asciidoc index 97a4948c43a7d..d9538fc436563 100644 --- a/docs/reference/ccr/apis/follow/put-follow.asciidoc +++ b/docs/reference/ccr/apis/follow/put-follow.asciidoc @@ -5,7 +5,7 @@ Create follower ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. diff --git a/docs/reference/ccr/apis/get-ccr-stats.asciidoc b/docs/reference/ccr/apis/get-ccr-stats.asciidoc index 69dae2ca69665..e92ad17e10437 100644 --- a/docs/reference/ccr/apis/get-ccr-stats.asciidoc +++ b/docs/reference/ccr/apis/get-ccr-stats.asciidoc @@ -6,7 +6,7 @@ Get {ccr-init} stats ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. diff --git a/docs/reference/cluster/allocation-explain.asciidoc b/docs/reference/cluster/allocation-explain.asciidoc index c3aae19e8e342..f5d7be7f52f30 100644 --- a/docs/reference/cluster/allocation-explain.asciidoc +++ b/docs/reference/cluster/allocation-explain.asciidoc @@ -4,7 +4,7 @@ Cluster allocation explain ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. diff --git a/docs/reference/cluster/cluster-info.asciidoc b/docs/reference/cluster/cluster-info.asciidoc index 2106fcfc69756..52ae637d8f46c 100644 --- a/docs/reference/cluster/cluster-info.asciidoc +++ b/docs/reference/cluster/cluster-info.asciidoc @@ -7,7 +7,7 @@ experimental::[] Cluster Info ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. diff --git a/docs/reference/cluster/delete-desired-balance.asciidoc b/docs/reference/cluster/delete-desired-balance.asciidoc index 49b555fd50057..45fa147258b78 100644 --- a/docs/reference/cluster/delete-desired-balance.asciidoc +++ b/docs/reference/cluster/delete-desired-balance.asciidoc @@ -6,7 +6,7 @@ NOTE: {cloud-only} -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. diff --git a/docs/reference/cluster/delete-desired-nodes.asciidoc b/docs/reference/cluster/delete-desired-nodes.asciidoc index 93e8f6484895d..883bc22f6d964 100644 --- a/docs/reference/cluster/delete-desired-nodes.asciidoc +++ b/docs/reference/cluster/delete-desired-nodes.asciidoc @@ -6,7 +6,7 @@ NOTE: {cloud-only} -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. diff --git a/docs/reference/cluster/get-desired-balance.asciidoc b/docs/reference/cluster/get-desired-balance.asciidoc index 381f263a5ee74..3c6b1dc48719c 100644 --- a/docs/reference/cluster/get-desired-balance.asciidoc +++ b/docs/reference/cluster/get-desired-balance.asciidoc @@ -6,7 +6,7 @@ NOTE: {cloud-only} -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. diff --git a/docs/reference/cluster/get-desired-nodes.asciidoc b/docs/reference/cluster/get-desired-nodes.asciidoc index c4182a37b2d00..56af6913e34ac 100644 --- a/docs/reference/cluster/get-desired-nodes.asciidoc +++ b/docs/reference/cluster/get-desired-nodes.asciidoc @@ -6,7 +6,7 @@ NOTE: {cloud-only} -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. diff --git a/docs/reference/cluster/get-settings.asciidoc b/docs/reference/cluster/get-settings.asciidoc index 0b577356aa765..5c0fe7a2026c7 100644 --- a/docs/reference/cluster/get-settings.asciidoc +++ b/docs/reference/cluster/get-settings.asciidoc @@ -4,7 +4,7 @@ Cluster get settings ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. diff --git a/docs/reference/cluster/health.asciidoc b/docs/reference/cluster/health.asciidoc index b24b408964d39..374dd5d4a6f82 100644 --- a/docs/reference/cluster/health.asciidoc +++ b/docs/reference/cluster/health.asciidoc @@ -4,7 +4,7 @@ Cluster health ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. diff --git a/docs/reference/cluster/nodes-hot-threads.asciidoc b/docs/reference/cluster/nodes-hot-threads.asciidoc index f78719772d5af..f8b414453ae66 100644 --- a/docs/reference/cluster/nodes-hot-threads.asciidoc +++ b/docs/reference/cluster/nodes-hot-threads.asciidoc @@ -4,7 +4,7 @@ Nodes hot threads ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. diff --git a/docs/reference/cluster/nodes-info.asciidoc b/docs/reference/cluster/nodes-info.asciidoc index 32959eda3176f..7ae6db7aa9a56 100644 --- a/docs/reference/cluster/nodes-info.asciidoc +++ b/docs/reference/cluster/nodes-info.asciidoc @@ -4,7 +4,7 @@ Nodes info ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. diff --git a/docs/reference/cluster/nodes-reload-secure-settings.asciidoc b/docs/reference/cluster/nodes-reload-secure-settings.asciidoc index 0db189a4a3966..842ca30c335f9 100644 --- a/docs/reference/cluster/nodes-reload-secure-settings.asciidoc +++ b/docs/reference/cluster/nodes-reload-secure-settings.asciidoc @@ -4,7 +4,7 @@ Nodes reload secure settings ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. diff --git a/docs/reference/cluster/nodes-stats.asciidoc b/docs/reference/cluster/nodes-stats.asciidoc index b1c6d3ab466a4..522983035079d 100644 --- a/docs/reference/cluster/nodes-stats.asciidoc +++ b/docs/reference/cluster/nodes-stats.asciidoc @@ -5,7 +5,7 @@ Nodes stats ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. diff --git a/docs/reference/cluster/nodes-usage.asciidoc b/docs/reference/cluster/nodes-usage.asciidoc index 58815b86a8815..c7994e32204a6 100644 --- a/docs/reference/cluster/nodes-usage.asciidoc +++ b/docs/reference/cluster/nodes-usage.asciidoc @@ -4,7 +4,7 @@ Nodes feature usage ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. diff --git a/docs/reference/cluster/pending.asciidoc b/docs/reference/cluster/pending.asciidoc index dd5146d0f04d4..f5d42a6df76a6 100644 --- a/docs/reference/cluster/pending.asciidoc +++ b/docs/reference/cluster/pending.asciidoc @@ -4,7 +4,7 @@ Pending cluster tasks ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. diff --git a/docs/reference/cluster/prevalidate-node-removal.asciidoc b/docs/reference/cluster/prevalidate-node-removal.asciidoc index d2c2fe562d561..0a09f1adda77c 100644 --- a/docs/reference/cluster/prevalidate-node-removal.asciidoc +++ b/docs/reference/cluster/prevalidate-node-removal.asciidoc @@ -6,7 +6,7 @@ NOTE: {cloud-only} -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. diff --git a/docs/reference/cluster/remote-info.asciidoc b/docs/reference/cluster/remote-info.asciidoc index bbfc44b6b5555..691acafd8ddbe 100644 --- a/docs/reference/cluster/remote-info.asciidoc +++ b/docs/reference/cluster/remote-info.asciidoc @@ -4,7 +4,7 @@ Remote cluster info ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. diff --git a/docs/reference/cluster/reroute.asciidoc b/docs/reference/cluster/reroute.asciidoc index eaca7f9171e84..217a0b6ccd3de 100644 --- a/docs/reference/cluster/reroute.asciidoc +++ b/docs/reference/cluster/reroute.asciidoc @@ -4,7 +4,7 @@ Cluster reroute ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. diff --git a/docs/reference/cluster/state.asciidoc b/docs/reference/cluster/state.asciidoc index cda375c514c34..bf2863018893a 100644 --- a/docs/reference/cluster/state.asciidoc +++ b/docs/reference/cluster/state.asciidoc @@ -4,7 +4,7 @@ Cluster state ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. diff --git a/docs/reference/cluster/stats.asciidoc b/docs/reference/cluster/stats.asciidoc index 278ac8ec78219..4a7a54a5b290d 100644 --- a/docs/reference/cluster/stats.asciidoc +++ b/docs/reference/cluster/stats.asciidoc @@ -5,7 +5,7 @@ Cluster stats ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. diff --git a/docs/reference/cluster/tasks.asciidoc b/docs/reference/cluster/tasks.asciidoc index 4d8703900337a..79727d9a3078b 100644 --- a/docs/reference/cluster/tasks.asciidoc +++ b/docs/reference/cluster/tasks.asciidoc @@ -6,7 +6,7 @@ beta::["The task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible.",{es-issue}51628] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-tasks[task management APIs]. diff --git a/docs/reference/cluster/update-desired-nodes.asciidoc b/docs/reference/cluster/update-desired-nodes.asciidoc index edcaeb745e7af..f83f551395134 100644 --- a/docs/reference/cluster/update-desired-nodes.asciidoc +++ b/docs/reference/cluster/update-desired-nodes.asciidoc @@ -6,7 +6,7 @@ NOTE: {cloud-only} -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. diff --git a/docs/reference/cluster/update-settings.asciidoc b/docs/reference/cluster/update-settings.asciidoc index add62f88bcf82..dcb0e9cda4610 100644 --- a/docs/reference/cluster/update-settings.asciidoc +++ b/docs/reference/cluster/update-settings.asciidoc @@ -4,7 +4,7 @@ Cluster update settings ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. diff --git a/docs/reference/cluster/voting-exclusions.asciidoc b/docs/reference/cluster/voting-exclusions.asciidoc index f1aa03c6550b0..e60b3be26508d 100644 --- a/docs/reference/cluster/voting-exclusions.asciidoc +++ b/docs/reference/cluster/voting-exclusions.asciidoc @@ -4,7 +4,7 @@ Voting configuration exclusions ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. diff --git a/docs/reference/connector/apis/cancel-connector-sync-job-api.asciidoc b/docs/reference/connector/apis/cancel-connector-sync-job-api.asciidoc index 0c3b7350d0aaf..d4db8ce62bc46 100644 --- a/docs/reference/connector/apis/cancel-connector-sync-job-api.asciidoc +++ b/docs/reference/connector/apis/cancel-connector-sync-job-api.asciidoc @@ -6,7 +6,7 @@ beta::[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. diff --git a/docs/reference/connector/apis/check-in-connector-api.asciidoc b/docs/reference/connector/apis/check-in-connector-api.asciidoc index 808f835a74844..be7521e937316 100644 --- a/docs/reference/connector/apis/check-in-connector-api.asciidoc +++ b/docs/reference/connector/apis/check-in-connector-api.asciidoc @@ -6,7 +6,7 @@ preview::[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. diff --git a/docs/reference/connector/apis/check-in-connector-sync-job-api.asciidoc b/docs/reference/connector/apis/check-in-connector-sync-job-api.asciidoc index 1aa5762e8e6f7..5f9b584621c2f 100644 --- a/docs/reference/connector/apis/check-in-connector-sync-job-api.asciidoc +++ b/docs/reference/connector/apis/check-in-connector-sync-job-api.asciidoc @@ -6,7 +6,7 @@ preview::[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. diff --git a/docs/reference/connector/apis/claim-connector-sync-job-api.asciidoc b/docs/reference/connector/apis/claim-connector-sync-job-api.asciidoc index c8de1efa07f23..565a39c2083af 100644 --- a/docs/reference/connector/apis/claim-connector-sync-job-api.asciidoc +++ b/docs/reference/connector/apis/claim-connector-sync-job-api.asciidoc @@ -6,7 +6,7 @@ preview::[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. diff --git a/docs/reference/connector/apis/connector-apis.asciidoc b/docs/reference/connector/apis/connector-apis.asciidoc index 33b58abd193b0..719db5a315714 100644 --- a/docs/reference/connector/apis/connector-apis.asciidoc +++ b/docs/reference/connector/apis/connector-apis.asciidoc @@ -1,7 +1,7 @@ [[connector-apis]] == Connector APIs -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. diff --git a/docs/reference/connector/apis/create-connector-api.asciidoc b/docs/reference/connector/apis/create-connector-api.asciidoc index 3b7ffd4b42553..3300ce270c345 100644 --- a/docs/reference/connector/apis/create-connector-api.asciidoc +++ b/docs/reference/connector/apis/create-connector-api.asciidoc @@ -6,7 +6,7 @@ beta::[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. diff --git a/docs/reference/connector/apis/create-connector-sync-job-api.asciidoc b/docs/reference/connector/apis/create-connector-sync-job-api.asciidoc index 58608bfd7fbd0..1a66d47578a8b 100644 --- a/docs/reference/connector/apis/create-connector-sync-job-api.asciidoc +++ b/docs/reference/connector/apis/create-connector-sync-job-api.asciidoc @@ -6,7 +6,7 @@ beta::[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. diff --git a/docs/reference/connector/apis/delete-connector-api.asciidoc b/docs/reference/connector/apis/delete-connector-api.asciidoc index ae2c2ac3b424d..b36a99bc2d8cc 100644 --- a/docs/reference/connector/apis/delete-connector-api.asciidoc +++ b/docs/reference/connector/apis/delete-connector-api.asciidoc @@ -6,7 +6,7 @@ beta::[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. diff --git a/docs/reference/connector/apis/delete-connector-sync-job-api.asciidoc b/docs/reference/connector/apis/delete-connector-sync-job-api.asciidoc index 67666392ad196..bc906d12cae40 100644 --- a/docs/reference/connector/apis/delete-connector-sync-job-api.asciidoc +++ b/docs/reference/connector/apis/delete-connector-sync-job-api.asciidoc @@ -6,7 +6,7 @@ beta::[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. diff --git a/docs/reference/connector/apis/get-connector-api.asciidoc b/docs/reference/connector/apis/get-connector-api.asciidoc index 50ec84617b9d2..cff13539f80cc 100644 --- a/docs/reference/connector/apis/get-connector-api.asciidoc +++ b/docs/reference/connector/apis/get-connector-api.asciidoc @@ -6,7 +6,7 @@ beta::[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. diff --git a/docs/reference/connector/apis/get-connector-sync-job-api.asciidoc b/docs/reference/connector/apis/get-connector-sync-job-api.asciidoc index e30b0e4ec98d6..f4ccc59e0315e 100644 --- a/docs/reference/connector/apis/get-connector-sync-job-api.asciidoc +++ b/docs/reference/connector/apis/get-connector-sync-job-api.asciidoc @@ -6,7 +6,7 @@ beta::[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. diff --git a/docs/reference/connector/apis/list-connector-sync-jobs-api.asciidoc b/docs/reference/connector/apis/list-connector-sync-jobs-api.asciidoc index 9bcf9fbb4b8ef..b5f52e31ac296 100644 --- a/docs/reference/connector/apis/list-connector-sync-jobs-api.asciidoc +++ b/docs/reference/connector/apis/list-connector-sync-jobs-api.asciidoc @@ -7,7 +7,7 @@ beta::[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. diff --git a/docs/reference/connector/apis/list-connectors-api.asciidoc b/docs/reference/connector/apis/list-connectors-api.asciidoc index 9e7ea17bfaa39..5cc099a6b67ee 100644 --- a/docs/reference/connector/apis/list-connectors-api.asciidoc +++ b/docs/reference/connector/apis/list-connectors-api.asciidoc @@ -7,7 +7,7 @@ beta::[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. diff --git a/docs/reference/connector/apis/set-connector-sync-job-error-api.asciidoc b/docs/reference/connector/apis/set-connector-sync-job-error-api.asciidoc index 2a29cd9ba54fc..b5a0cd667f3ee 100644 --- a/docs/reference/connector/apis/set-connector-sync-job-error-api.asciidoc +++ b/docs/reference/connector/apis/set-connector-sync-job-error-api.asciidoc @@ -6,7 +6,7 @@ preview::[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. diff --git a/docs/reference/connector/apis/set-connector-sync-job-stats-api.asciidoc b/docs/reference/connector/apis/set-connector-sync-job-stats-api.asciidoc index 63c4a0ee152bc..5691280a30dd7 100644 --- a/docs/reference/connector/apis/set-connector-sync-job-stats-api.asciidoc +++ b/docs/reference/connector/apis/set-connector-sync-job-stats-api.asciidoc @@ -6,7 +6,7 @@ preview::[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. diff --git a/docs/reference/connector/apis/update-connector-api-key-id-api.asciidoc b/docs/reference/connector/apis/update-connector-api-key-id-api.asciidoc index 440b8025138f2..8df49c43c128e 100644 --- a/docs/reference/connector/apis/update-connector-api-key-id-api.asciidoc +++ b/docs/reference/connector/apis/update-connector-api-key-id-api.asciidoc @@ -6,7 +6,7 @@ beta::[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. diff --git a/docs/reference/connector/apis/update-connector-configuration-api.asciidoc b/docs/reference/connector/apis/update-connector-configuration-api.asciidoc index a987b03c76744..d02c332d7f34b 100644 --- a/docs/reference/connector/apis/update-connector-configuration-api.asciidoc +++ b/docs/reference/connector/apis/update-connector-configuration-api.asciidoc @@ -6,7 +6,7 @@ beta::[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. diff --git a/docs/reference/connector/apis/update-connector-error-api.asciidoc b/docs/reference/connector/apis/update-connector-error-api.asciidoc index 278f9377b91d6..859a48c31c0ca 100644 --- a/docs/reference/connector/apis/update-connector-error-api.asciidoc +++ b/docs/reference/connector/apis/update-connector-error-api.asciidoc @@ -6,7 +6,7 @@ preview::[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. diff --git a/docs/reference/connector/apis/update-connector-features-api.asciidoc b/docs/reference/connector/apis/update-connector-features-api.asciidoc index d9da7b767e479..74c512e42cd1b 100644 --- a/docs/reference/connector/apis/update-connector-features-api.asciidoc +++ b/docs/reference/connector/apis/update-connector-features-api.asciidoc @@ -6,7 +6,7 @@ beta::[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. diff --git a/docs/reference/connector/apis/update-connector-filtering-api.asciidoc b/docs/reference/connector/apis/update-connector-filtering-api.asciidoc index 3cebee37b5339..7ba0080cde28f 100644 --- a/docs/reference/connector/apis/update-connector-filtering-api.asciidoc +++ b/docs/reference/connector/apis/update-connector-filtering-api.asciidoc @@ -6,7 +6,7 @@ beta::[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. diff --git a/docs/reference/connector/apis/update-connector-index-name-api.asciidoc b/docs/reference/connector/apis/update-connector-index-name-api.asciidoc index 7a7e9fc535ef8..fbbef6e66ca40 100644 --- a/docs/reference/connector/apis/update-connector-index-name-api.asciidoc +++ b/docs/reference/connector/apis/update-connector-index-name-api.asciidoc @@ -6,7 +6,7 @@ beta::[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. diff --git a/docs/reference/connector/apis/update-connector-last-sync-api.asciidoc b/docs/reference/connector/apis/update-connector-last-sync-api.asciidoc index 9fa3aeaa3a568..d827d25c12b4e 100644 --- a/docs/reference/connector/apis/update-connector-last-sync-api.asciidoc +++ b/docs/reference/connector/apis/update-connector-last-sync-api.asciidoc @@ -6,7 +6,7 @@ preview::[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. diff --git a/docs/reference/connector/apis/update-connector-name-description-api.asciidoc b/docs/reference/connector/apis/update-connector-name-description-api.asciidoc index 0a0a635677065..c0d0568baef35 100644 --- a/docs/reference/connector/apis/update-connector-name-description-api.asciidoc +++ b/docs/reference/connector/apis/update-connector-name-description-api.asciidoc @@ -6,7 +6,7 @@ beta::[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. diff --git a/docs/reference/connector/apis/update-connector-pipeline-api.asciidoc b/docs/reference/connector/apis/update-connector-pipeline-api.asciidoc index 666897a5f9a84..a886fe6f20da7 100644 --- a/docs/reference/connector/apis/update-connector-pipeline-api.asciidoc +++ b/docs/reference/connector/apis/update-connector-pipeline-api.asciidoc @@ -6,7 +6,7 @@ beta::[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. diff --git a/docs/reference/connector/apis/update-connector-scheduling-api.asciidoc b/docs/reference/connector/apis/update-connector-scheduling-api.asciidoc index af3b353eaf944..eed3d14ea1d97 100644 --- a/docs/reference/connector/apis/update-connector-scheduling-api.asciidoc +++ b/docs/reference/connector/apis/update-connector-scheduling-api.asciidoc @@ -6,7 +6,7 @@ beta::[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. diff --git a/docs/reference/connector/apis/update-connector-service-type-api.asciidoc b/docs/reference/connector/apis/update-connector-service-type-api.asciidoc index e92f8cd96b4ce..28b4c72b682d2 100644 --- a/docs/reference/connector/apis/update-connector-service-type-api.asciidoc +++ b/docs/reference/connector/apis/update-connector-service-type-api.asciidoc @@ -6,7 +6,7 @@ beta::[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. diff --git a/docs/reference/connector/apis/update-connector-status-api.asciidoc b/docs/reference/connector/apis/update-connector-status-api.asciidoc index 910cc32605db9..7812cbff89d1b 100644 --- a/docs/reference/connector/apis/update-connector-status-api.asciidoc +++ b/docs/reference/connector/apis/update-connector-status-api.asciidoc @@ -6,7 +6,7 @@ preview::[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. diff --git a/docs/reference/data-streams/data-stream-apis.asciidoc b/docs/reference/data-streams/data-stream-apis.asciidoc index 66662ef4a2180..8b952fad59f8d 100644 --- a/docs/reference/data-streams/data-stream-apis.asciidoc +++ b/docs/reference/data-streams/data-stream-apis.asciidoc @@ -2,7 +2,7 @@ [[data-stream-apis]] == Data stream APIs -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. diff --git a/docs/reference/data-streams/lifecycle/apis/delete-lifecycle.asciidoc b/docs/reference/data-streams/lifecycle/apis/delete-lifecycle.asciidoc index 70e901bb43b91..5222d33b5870b 100644 --- a/docs/reference/data-streams/lifecycle/apis/delete-lifecycle.asciidoc +++ b/docs/reference/data-streams/lifecycle/apis/delete-lifecycle.asciidoc @@ -4,7 +4,7 @@ Delete Data Stream Lifecycle ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. diff --git a/docs/reference/data-streams/lifecycle/apis/explain-lifecycle.asciidoc b/docs/reference/data-streams/lifecycle/apis/explain-lifecycle.asciidoc index 0a76114abfa0e..8289fb54d51bd 100644 --- a/docs/reference/data-streams/lifecycle/apis/explain-lifecycle.asciidoc +++ b/docs/reference/data-streams/lifecycle/apis/explain-lifecycle.asciidoc @@ -4,7 +4,7 @@ Explain Data Stream Lifecycle ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. diff --git a/docs/reference/data-streams/lifecycle/apis/get-lifecycle-stats.asciidoc b/docs/reference/data-streams/lifecycle/apis/get-lifecycle-stats.asciidoc index ba33574b49775..0fbe7de287f7b 100644 --- a/docs/reference/data-streams/lifecycle/apis/get-lifecycle-stats.asciidoc +++ b/docs/reference/data-streams/lifecycle/apis/get-lifecycle-stats.asciidoc @@ -4,7 +4,7 @@ Get Data Stream Lifecycle ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. diff --git a/docs/reference/data-streams/lifecycle/apis/get-lifecycle.asciidoc b/docs/reference/data-streams/lifecycle/apis/get-lifecycle.asciidoc index 32e68c0c3c31f..57d63fee2ddc1 100644 --- a/docs/reference/data-streams/lifecycle/apis/get-lifecycle.asciidoc +++ b/docs/reference/data-streams/lifecycle/apis/get-lifecycle.asciidoc @@ -4,7 +4,7 @@ Get Data Stream Lifecycle ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. diff --git a/docs/reference/data-streams/lifecycle/apis/put-lifecycle.asciidoc b/docs/reference/data-streams/lifecycle/apis/put-lifecycle.asciidoc index e2eb52959c957..c5002cf4882e2 100644 --- a/docs/reference/data-streams/lifecycle/apis/put-lifecycle.asciidoc +++ b/docs/reference/data-streams/lifecycle/apis/put-lifecycle.asciidoc @@ -4,7 +4,7 @@ Put Data Stream Lifecycle ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. diff --git a/docs/reference/data-streams/modify-data-streams-api.asciidoc b/docs/reference/data-streams/modify-data-streams-api.asciidoc index 0820342134678..2f717f9ec3b4b 100644 --- a/docs/reference/data-streams/modify-data-streams-api.asciidoc +++ b/docs/reference/data-streams/modify-data-streams-api.asciidoc @@ -4,7 +4,7 @@ Modify data streams ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. diff --git a/docs/reference/data-streams/promote-data-stream-api.asciidoc b/docs/reference/data-streams/promote-data-stream-api.asciidoc index a050b9e014b71..8247d092bcb29 100644 --- a/docs/reference/data-streams/promote-data-stream-api.asciidoc +++ b/docs/reference/data-streams/promote-data-stream-api.asciidoc @@ -5,7 +5,7 @@ Promote data stream ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. diff --git a/docs/reference/docs/bulk.asciidoc b/docs/reference/docs/bulk.asciidoc index 9b12efb466cab..d6a555de34aef 100644 --- a/docs/reference/docs/bulk.asciidoc +++ b/docs/reference/docs/bulk.asciidoc @@ -4,7 +4,7 @@ Bulk ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-document[Document APIs]. diff --git a/docs/reference/docs/delete.asciidoc b/docs/reference/docs/delete.asciidoc index 9665619096639..046a20abdaffb 100644 --- a/docs/reference/docs/delete.asciidoc +++ b/docs/reference/docs/delete.asciidoc @@ -4,7 +4,7 @@ Delete ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-document[Document APIs]. diff --git a/docs/reference/docs/get.asciidoc b/docs/reference/docs/get.asciidoc index bdbcb08e186c9..a3ff70fb95f6e 100644 --- a/docs/reference/docs/get.asciidoc +++ b/docs/reference/docs/get.asciidoc @@ -4,7 +4,7 @@ Get ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-document[Document APIs]. diff --git a/docs/reference/docs/multi-get.asciidoc b/docs/reference/docs/multi-get.asciidoc index b27bd6a97d534..293bd2568a34b 100644 --- a/docs/reference/docs/multi-get.asciidoc +++ b/docs/reference/docs/multi-get.asciidoc @@ -4,7 +4,7 @@ Multi get ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-document[Document APIs]. diff --git a/docs/reference/docs/reindex.asciidoc b/docs/reference/docs/reindex.asciidoc index 26e4d1ab67c5f..2f6ddd344eaab 100644 --- a/docs/reference/docs/reindex.asciidoc +++ b/docs/reference/docs/reindex.asciidoc @@ -4,7 +4,7 @@ Reindex ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-document[Document APIs]. diff --git a/docs/reference/docs/termvectors.asciidoc b/docs/reference/docs/termvectors.asciidoc index 285db46fd4d21..d40452fb4875a 100644 --- a/docs/reference/docs/termvectors.asciidoc +++ b/docs/reference/docs/termvectors.asciidoc @@ -4,7 +4,7 @@ Term vectors ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-document[Document APIs]. diff --git a/docs/reference/docs/update-by-query.asciidoc b/docs/reference/docs/update-by-query.asciidoc index c5fccc86a1cc9..c8d68082c8ea1 100644 --- a/docs/reference/docs/update-by-query.asciidoc +++ b/docs/reference/docs/update-by-query.asciidoc @@ -4,7 +4,7 @@ Update by query ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-document[Document APIs]. diff --git a/docs/reference/docs/update.asciidoc b/docs/reference/docs/update.asciidoc index 619cc921c4d6d..ae9ae8fe73fc6 100644 --- a/docs/reference/docs/update.asciidoc +++ b/docs/reference/docs/update.asciidoc @@ -4,7 +4,7 @@ Update ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-document[Document APIs]. diff --git a/docs/reference/eql/delete-async-eql-search-api.asciidoc b/docs/reference/eql/delete-async-eql-search-api.asciidoc index f3c516188c258..2783c9ac0b871 100644 --- a/docs/reference/eql/delete-async-eql-search-api.asciidoc +++ b/docs/reference/eql/delete-async-eql-search-api.asciidoc @@ -6,7 +6,7 @@ Delete async EQL search ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-eql[EQL APIs]. diff --git a/docs/reference/eql/eql-apis.asciidoc b/docs/reference/eql/eql-apis.asciidoc index 0bf7462d8f4d8..4d6aafd2039df 100644 --- a/docs/reference/eql/eql-apis.asciidoc +++ b/docs/reference/eql/eql-apis.asciidoc @@ -1,7 +1,7 @@ [[eql-apis]] == EQL APIs -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-eql[EQL APIs]. diff --git a/docs/reference/eql/eql-search-api.asciidoc b/docs/reference/eql/eql-search-api.asciidoc index 97da43a6775b2..afe97ec942312 100644 --- a/docs/reference/eql/eql-search-api.asciidoc +++ b/docs/reference/eql/eql-search-api.asciidoc @@ -6,7 +6,7 @@ EQL search ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-eql[EQL APIs]. diff --git a/docs/reference/eql/get-async-eql-search-api.asciidoc b/docs/reference/eql/get-async-eql-search-api.asciidoc index 36f18a7061bc4..ff4a07811b732 100644 --- a/docs/reference/eql/get-async-eql-search-api.asciidoc +++ b/docs/reference/eql/get-async-eql-search-api.asciidoc @@ -6,7 +6,7 @@ Get async EQL search ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-eql[EQL APIs]. diff --git a/docs/reference/eql/get-async-eql-status-api.asciidoc b/docs/reference/eql/get-async-eql-status-api.asciidoc index fe188ec9112ea..cb3904a644921 100644 --- a/docs/reference/eql/get-async-eql-status-api.asciidoc +++ b/docs/reference/eql/get-async-eql-status-api.asciidoc @@ -6,7 +6,7 @@ Get async EQL search status ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-eql[EQL APIs]. diff --git a/docs/reference/esql/esql-apis.asciidoc b/docs/reference/esql/esql-apis.asciidoc index 57747d3e357ee..157f4e4357e78 100644 --- a/docs/reference/esql/esql-apis.asciidoc +++ b/docs/reference/esql/esql-apis.asciidoc @@ -1,7 +1,7 @@ [[esql-apis]] == {esql} APIs -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-esql[ES|QL APIs]. diff --git a/docs/reference/esql/esql-async-query-api.asciidoc b/docs/reference/esql/esql-async-query-api.asciidoc index 76597822a3fa8..8cb974cf6773b 100644 --- a/docs/reference/esql/esql-async-query-api.asciidoc +++ b/docs/reference/esql/esql-async-query-api.asciidoc @@ -4,7 +4,7 @@ {esql} async query API ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-esql[ES|QL APIs]. diff --git a/docs/reference/esql/esql-async-query-delete-api.asciidoc b/docs/reference/esql/esql-async-query-delete-api.asciidoc index a3f21ad81e448..421c59191f3bd 100644 --- a/docs/reference/esql/esql-async-query-delete-api.asciidoc +++ b/docs/reference/esql/esql-async-query-delete-api.asciidoc @@ -4,7 +4,7 @@ {esql} async query delete API ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-esql[ES|QL APIs]. diff --git a/docs/reference/esql/esql-async-query-get-api.asciidoc b/docs/reference/esql/esql-async-query-get-api.asciidoc index c7ba3b2ce53e1..0b5d687c48cb8 100644 --- a/docs/reference/esql/esql-async-query-get-api.asciidoc +++ b/docs/reference/esql/esql-async-query-get-api.asciidoc @@ -4,7 +4,7 @@ {esql} async query get API ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-esql[ES|QL APIs]. diff --git a/docs/reference/esql/esql-query-api.asciidoc b/docs/reference/esql/esql-query-api.asciidoc index 88fae50fae4b9..e5b29a5ca25f1 100644 --- a/docs/reference/esql/esql-query-api.asciidoc +++ b/docs/reference/esql/esql-query-api.asciidoc @@ -4,7 +4,7 @@ {esql} query API ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-esql[ES|QL APIs]. diff --git a/docs/reference/features/apis/features-apis.asciidoc b/docs/reference/features/apis/features-apis.asciidoc index 94055a0a41d7c..2582446340f15 100644 --- a/docs/reference/features/apis/features-apis.asciidoc +++ b/docs/reference/features/apis/features-apis.asciidoc @@ -1,7 +1,7 @@ [[features-apis]] == Features APIs -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-features[Features APIs]. diff --git a/docs/reference/features/apis/get-features-api.asciidoc b/docs/reference/features/apis/get-features-api.asciidoc index 3df7ccb536890..62986d7728ca7 100644 --- a/docs/reference/features/apis/get-features-api.asciidoc +++ b/docs/reference/features/apis/get-features-api.asciidoc @@ -4,7 +4,7 @@ Get features ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-features[Features APIs]. diff --git a/docs/reference/features/apis/reset-features-api.asciidoc b/docs/reference/features/apis/reset-features-api.asciidoc index 5223315caa56b..e2d3f249304bf 100644 --- a/docs/reference/features/apis/reset-features-api.asciidoc +++ b/docs/reference/features/apis/reset-features-api.asciidoc @@ -6,7 +6,7 @@ experimental::[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-features[Features APIs]. diff --git a/docs/reference/fleet/fleet-multi-search.asciidoc b/docs/reference/fleet/fleet-multi-search.asciidoc index eaec76ebdd830..5673e1abbbd1d 100644 --- a/docs/reference/fleet/fleet-multi-search.asciidoc +++ b/docs/reference/fleet/fleet-multi-search.asciidoc @@ -5,7 +5,7 @@ Fleet multi search ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-fleet[{fleet} APIs]. diff --git a/docs/reference/fleet/fleet-search.asciidoc b/docs/reference/fleet/fleet-search.asciidoc index 10e77d9e66527..81ad0c9a7aa95 100644 --- a/docs/reference/fleet/fleet-search.asciidoc +++ b/docs/reference/fleet/fleet-search.asciidoc @@ -5,7 +5,7 @@ Fleet search ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-fleet[{fleet} APIs]. diff --git a/docs/reference/fleet/index.asciidoc b/docs/reference/fleet/index.asciidoc index bdffee2270297..8cd3cd59f21b0 100644 --- a/docs/reference/fleet/index.asciidoc +++ b/docs/reference/fleet/index.asciidoc @@ -2,7 +2,7 @@ [[fleet-apis]] == Fleet APIs -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-fleet[{fleet} APIs]. diff --git a/docs/reference/graph/explore.asciidoc b/docs/reference/graph/explore.asciidoc index 1f5faeda76ef5..60e9edb3b0f38 100644 --- a/docs/reference/graph/explore.asciidoc +++ b/docs/reference/graph/explore.asciidoc @@ -2,7 +2,7 @@ [[graph-explore-api]] == Graph explore API -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-graph[Graph explore APIs]. diff --git a/docs/reference/health/health.asciidoc b/docs/reference/health/health.asciidoc index 7077cb28f8946..606804a83bbda 100644 --- a/docs/reference/health/health.asciidoc +++ b/docs/reference/health/health.asciidoc @@ -4,7 +4,7 @@ Health ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-health_report[Cluster health APIs]. diff --git a/docs/reference/ilm/apis/delete-lifecycle.asciidoc b/docs/reference/ilm/apis/delete-lifecycle.asciidoc index fc9a35e4ef570..64a421f091eff 100644 --- a/docs/reference/ilm/apis/delete-lifecycle.asciidoc +++ b/docs/reference/ilm/apis/delete-lifecycle.asciidoc @@ -5,6 +5,12 @@ Delete policy ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ilm[{ilm-cap} APIs]. +-- + Deletes an index <> policy. [[ilm-delete-lifecycle-request]] diff --git a/docs/reference/ilm/apis/explain.asciidoc b/docs/reference/ilm/apis/explain.asciidoc index 31c6ae9e82ec7..4cc2667186442 100644 --- a/docs/reference/ilm/apis/explain.asciidoc +++ b/docs/reference/ilm/apis/explain.asciidoc @@ -5,6 +5,12 @@ Explain lifecycle ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ilm[{ilm-cap} APIs]. +-- + Retrieves the current <> status for one or more indices. For data streams, the API retrieves the current lifecycle status for the stream's backing indices. diff --git a/docs/reference/ilm/apis/get-lifecycle.asciidoc b/docs/reference/ilm/apis/get-lifecycle.asciidoc index b4e07389a9fb7..b02d129ebe734 100644 --- a/docs/reference/ilm/apis/get-lifecycle.asciidoc +++ b/docs/reference/ilm/apis/get-lifecycle.asciidoc @@ -5,6 +5,12 @@ Get policy ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ilm[{ilm-cap} APIs]. +-- + Retrieves a <> policy. [[ilm-get-lifecycle-request]] diff --git a/docs/reference/ilm/apis/get-status.asciidoc b/docs/reference/ilm/apis/get-status.asciidoc index f2ab8d65ec9a1..648080f26b79b 100644 --- a/docs/reference/ilm/apis/get-status.asciidoc +++ b/docs/reference/ilm/apis/get-status.asciidoc @@ -7,6 +7,12 @@ Get {ilm} status ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ilm[{ilm-cap} APIs]. +-- + Retrieves the current <> ({ilm-init}) status. You can start or stop {ilm-init} with the <> and diff --git a/docs/reference/ilm/apis/ilm-api.asciidoc b/docs/reference/ilm/apis/ilm-api.asciidoc index 3a6c8430bb4c6..9cc594be1bea7 100644 --- a/docs/reference/ilm/apis/ilm-api.asciidoc +++ b/docs/reference/ilm/apis/ilm-api.asciidoc @@ -1,13 +1,12 @@ [[index-lifecycle-management-api]] == {ilm-cap} APIs +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-ilm[{ilm-cap} APIs]. -- -https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-ilm - You use the following APIs to set up policies to automatically manage the index lifecycle. For more information about {ilm} ({ilm-init}), see <>. diff --git a/docs/reference/ilm/apis/migrate-to-data-tiers.asciidoc b/docs/reference/ilm/apis/migrate-to-data-tiers.asciidoc index 8ba57120a8a65..76810170daa19 100644 --- a/docs/reference/ilm/apis/migrate-to-data-tiers.asciidoc +++ b/docs/reference/ilm/apis/migrate-to-data-tiers.asciidoc @@ -5,6 +5,12 @@ Migrate indices, ILM policies, and legacy, composable and component templates to data tiers routing ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ilm[{ilm-cap} APIs]. +-- + Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and <> to using <>, and optionally deletes one legacy index template. diff --git a/docs/reference/ilm/apis/move-to-step.asciidoc b/docs/reference/ilm/apis/move-to-step.asciidoc index f3441fa997cff..a7a8cacf551db 100644 --- a/docs/reference/ilm/apis/move-to-step.asciidoc +++ b/docs/reference/ilm/apis/move-to-step.asciidoc @@ -5,6 +5,12 @@ Move to step ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ilm[{ilm-cap} APIs]. +-- + Triggers execution of a specific step in the <> policy. [[ilm-move-to-step-request]] diff --git a/docs/reference/ilm/apis/put-lifecycle.asciidoc b/docs/reference/ilm/apis/put-lifecycle.asciidoc index 390f6b1bb4d15..3aa691ab06da9 100644 --- a/docs/reference/ilm/apis/put-lifecycle.asciidoc +++ b/docs/reference/ilm/apis/put-lifecycle.asciidoc @@ -5,6 +5,12 @@ Create or update lifecycle policy ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ilm[{ilm-cap} APIs]. +-- + Creates or updates <> policy. See <> for definitions of policy components. diff --git a/docs/reference/ilm/apis/remove-policy-from-index.asciidoc b/docs/reference/ilm/apis/remove-policy-from-index.asciidoc index 107cab4d5aa19..5b5842f28619c 100644 --- a/docs/reference/ilm/apis/remove-policy-from-index.asciidoc +++ b/docs/reference/ilm/apis/remove-policy-from-index.asciidoc @@ -5,6 +5,12 @@ Remove policy ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ilm[{ilm-cap} APIs]. +-- + Removes assigned <> policies from an index or a data stream's backing indices. diff --git a/docs/reference/ilm/apis/retry-policy.asciidoc b/docs/reference/ilm/apis/retry-policy.asciidoc index 8f01f15e0c3ad..a41d064b73400 100644 --- a/docs/reference/ilm/apis/retry-policy.asciidoc +++ b/docs/reference/ilm/apis/retry-policy.asciidoc @@ -5,6 +5,12 @@ Retry policy ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ilm[{ilm-cap} APIs]. +-- + Retry executing the <> policy for an index that is in the ERROR step. [[ilm-retry-policy-request]] diff --git a/docs/reference/ilm/apis/start.asciidoc b/docs/reference/ilm/apis/start.asciidoc index c38b3d9ca8831..ce9b64455be05 100644 --- a/docs/reference/ilm/apis/start.asciidoc +++ b/docs/reference/ilm/apis/start.asciidoc @@ -7,6 +7,12 @@ Start {ilm} ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ilm[{ilm-cap} APIs]. +-- + Start the <> ({ilm-init}) plugin. [[ilm-start-request]] diff --git a/docs/reference/ilm/apis/stop.asciidoc b/docs/reference/ilm/apis/stop.asciidoc index a6100d794c2d3..50d8aaf4e1fd6 100644 --- a/docs/reference/ilm/apis/stop.asciidoc +++ b/docs/reference/ilm/apis/stop.asciidoc @@ -7,6 +7,12 @@ Stop {ilm} ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ilm[{ilm-cap} APIs]. +-- + Stop the <> ({ilm-init}) plugin. [[ilm-stop-request]] diff --git a/docs/reference/indices/add-alias.asciidoc b/docs/reference/indices/add-alias.asciidoc index b8f6362f974cb..13b49f5a47dd1 100644 --- a/docs/reference/indices/add-alias.asciidoc +++ b/docs/reference/indices/add-alias.asciidoc @@ -4,7 +4,7 @@ Create or update alias ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/alias-exists.asciidoc b/docs/reference/indices/alias-exists.asciidoc index 5a43b10568d52..f654604516676 100644 --- a/docs/reference/indices/alias-exists.asciidoc +++ b/docs/reference/indices/alias-exists.asciidoc @@ -4,7 +4,7 @@ Alias exists ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/aliases.asciidoc b/docs/reference/indices/aliases.asciidoc index cff331d88af94..243f436f55b5a 100644 --- a/docs/reference/indices/aliases.asciidoc +++ b/docs/reference/indices/aliases.asciidoc @@ -4,7 +4,7 @@ Aliases ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/analyze.asciidoc b/docs/reference/indices/analyze.asciidoc index 49e1c9de749ff..a211a44730a64 100644 --- a/docs/reference/indices/analyze.asciidoc +++ b/docs/reference/indices/analyze.asciidoc @@ -4,7 +4,7 @@ Analyze ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/apis/reload-analyzers.asciidoc b/docs/reference/indices/apis/reload-analyzers.asciidoc index ca5f540564f8e..a27a3bb859cf1 100644 --- a/docs/reference/indices/apis/reload-analyzers.asciidoc +++ b/docs/reference/indices/apis/reload-analyzers.asciidoc @@ -2,6 +2,12 @@ [[indices-reload-analyzers]] == Reload search analyzers API +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/operation/operation-indices-reload-search-analyzers[Reload search analyzers]. +-- + Reloads an index's <> and their resources. For data streams, the API reloads search analyzers and resources for the stream's backing indices. diff --git a/docs/reference/indices/apis/unfreeze.asciidoc b/docs/reference/indices/apis/unfreeze.asciidoc index ece1f37c77848..5d04d44db7443 100644 --- a/docs/reference/indices/apis/unfreeze.asciidoc +++ b/docs/reference/indices/apis/unfreeze.asciidoc @@ -17,7 +17,7 @@ You can use this API to unfreeze indices that were frozen in 7.x. Frozen indices are not related to the frozen data tier. ==== -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/clearcache.asciidoc b/docs/reference/indices/clearcache.asciidoc index 19b2d204356ab..f981a6d69dd63 100644 --- a/docs/reference/indices/clearcache.asciidoc +++ b/docs/reference/indices/clearcache.asciidoc @@ -4,7 +4,7 @@ Clear cache ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/clone-index.asciidoc b/docs/reference/indices/clone-index.asciidoc index 192cf7035b844..734ff33e48215 100644 --- a/docs/reference/indices/clone-index.asciidoc +++ b/docs/reference/indices/clone-index.asciidoc @@ -4,7 +4,7 @@ Clone index ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/close.asciidoc b/docs/reference/indices/close.asciidoc index a3014f811a1b7..56d318aad2f7a 100644 --- a/docs/reference/indices/close.asciidoc +++ b/docs/reference/indices/close.asciidoc @@ -4,7 +4,7 @@ Close index ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/create-data-stream.asciidoc b/docs/reference/indices/create-data-stream.asciidoc index 278670047d4ce..dd2d471117949 100644 --- a/docs/reference/indices/create-data-stream.asciidoc +++ b/docs/reference/indices/create-data-stream.asciidoc @@ -5,7 +5,7 @@ Create data stream ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. diff --git a/docs/reference/indices/create-index.asciidoc b/docs/reference/indices/create-index.asciidoc index 9a3934efa718a..a210b05b2bcf0 100644 --- a/docs/reference/indices/create-index.asciidoc +++ b/docs/reference/indices/create-index.asciidoc @@ -4,7 +4,7 @@ Create index ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/dangling-index-delete.asciidoc b/docs/reference/indices/dangling-index-delete.asciidoc index 0afe9e0204bc6..b1fd6790972c4 100644 --- a/docs/reference/indices/dangling-index-delete.asciidoc +++ b/docs/reference/indices/dangling-index-delete.asciidoc @@ -4,7 +4,7 @@ Delete dangling index ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/dangling-index-import.asciidoc b/docs/reference/indices/dangling-index-import.asciidoc index 2b5922a2c0cf2..e266ecd2c9c70 100644 --- a/docs/reference/indices/dangling-index-import.asciidoc +++ b/docs/reference/indices/dangling-index-import.asciidoc @@ -4,7 +4,7 @@ Import dangling index ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/dangling-indices-list.asciidoc b/docs/reference/indices/dangling-indices-list.asciidoc index b098cb696e5f9..2b7dcdc497ebf 100644 --- a/docs/reference/indices/dangling-indices-list.asciidoc +++ b/docs/reference/indices/dangling-indices-list.asciidoc @@ -4,7 +4,7 @@ List dangling indices ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/data-stream-stats.asciidoc b/docs/reference/indices/data-stream-stats.asciidoc index 1d664e85628e8..cce145b4dadcc 100644 --- a/docs/reference/indices/data-stream-stats.asciidoc +++ b/docs/reference/indices/data-stream-stats.asciidoc @@ -5,7 +5,7 @@ Data stream stats ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. diff --git a/docs/reference/indices/delete-alias.asciidoc b/docs/reference/indices/delete-alias.asciidoc index 5a8baa262d998..c204c89579352 100644 --- a/docs/reference/indices/delete-alias.asciidoc +++ b/docs/reference/indices/delete-alias.asciidoc @@ -4,7 +4,7 @@ Delete alias ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/delete-component-template.asciidoc b/docs/reference/indices/delete-component-template.asciidoc index 0affd9e4d424b..27c1e00a5d57a 100644 --- a/docs/reference/indices/delete-component-template.asciidoc +++ b/docs/reference/indices/delete-component-template.asciidoc @@ -4,7 +4,7 @@ Delete component template ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/delete-data-stream.asciidoc b/docs/reference/indices/delete-data-stream.asciidoc index b8339624c837c..1cb43a615ede8 100644 --- a/docs/reference/indices/delete-data-stream.asciidoc +++ b/docs/reference/indices/delete-data-stream.asciidoc @@ -5,7 +5,7 @@ Delete data stream ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. diff --git a/docs/reference/indices/delete-index-template-v1.asciidoc b/docs/reference/indices/delete-index-template-v1.asciidoc index e8d5e2e355a56..e035c13a7bceb 100644 --- a/docs/reference/indices/delete-index-template-v1.asciidoc +++ b/docs/reference/indices/delete-index-template-v1.asciidoc @@ -9,7 +9,7 @@ templates>>, which are deprecated and will be replaced by the composable templates introduced in {es} 7.8. For information about composable templates, see <>. -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/delete-index-template.asciidoc b/docs/reference/indices/delete-index-template.asciidoc index 430a18470da4a..23713f62fa031 100644 --- a/docs/reference/indices/delete-index-template.asciidoc +++ b/docs/reference/indices/delete-index-template.asciidoc @@ -4,7 +4,7 @@ Delete index template ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/delete-index.asciidoc b/docs/reference/indices/delete-index.asciidoc index ec147fb10ff30..81ee7b502d377 100644 --- a/docs/reference/indices/delete-index.asciidoc +++ b/docs/reference/indices/delete-index.asciidoc @@ -4,7 +4,7 @@ Delete index ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/diskusage.asciidoc b/docs/reference/indices/diskusage.asciidoc index 85d84ea9ad43d..6db122ab7d836 100644 --- a/docs/reference/indices/diskusage.asciidoc +++ b/docs/reference/indices/diskusage.asciidoc @@ -6,7 +6,7 @@ experimental[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/downsample-data-stream.asciidoc b/docs/reference/indices/downsample-data-stream.asciidoc index ecff35033e2d5..a99d7b246ba43 100644 --- a/docs/reference/indices/downsample-data-stream.asciidoc +++ b/docs/reference/indices/downsample-data-stream.asciidoc @@ -5,7 +5,7 @@ Downsample ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. diff --git a/docs/reference/indices/field-usage-stats.asciidoc b/docs/reference/indices/field-usage-stats.asciidoc index f50c97ceddf08..cbb65f8c2effb 100644 --- a/docs/reference/indices/field-usage-stats.asciidoc +++ b/docs/reference/indices/field-usage-stats.asciidoc @@ -6,7 +6,7 @@ experimental[] -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/flush.asciidoc b/docs/reference/indices/flush.asciidoc index 03fd2c175ba53..a458e6906b62f 100644 --- a/docs/reference/indices/flush.asciidoc +++ b/docs/reference/indices/flush.asciidoc @@ -4,7 +4,7 @@ Flush ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/forcemerge.asciidoc b/docs/reference/indices/forcemerge.asciidoc index 000b6bfa97f6c..4bac16f1aa659 100644 --- a/docs/reference/indices/forcemerge.asciidoc +++ b/docs/reference/indices/forcemerge.asciidoc @@ -4,7 +4,7 @@ Force merge ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/get-alias.asciidoc b/docs/reference/indices/get-alias.asciidoc index f03a06fe3074e..154aea0ac4890 100644 --- a/docs/reference/indices/get-alias.asciidoc +++ b/docs/reference/indices/get-alias.asciidoc @@ -4,7 +4,7 @@ Get alias ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/get-component-template.asciidoc b/docs/reference/indices/get-component-template.asciidoc index c98606e23303d..e7ef16de1b749 100644 --- a/docs/reference/indices/get-component-template.asciidoc +++ b/docs/reference/indices/get-component-template.asciidoc @@ -4,7 +4,7 @@ Get component template ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/get-data-stream.asciidoc b/docs/reference/indices/get-data-stream.asciidoc index 88f136d0726f7..ccab53f020e5f 100644 --- a/docs/reference/indices/get-data-stream.asciidoc +++ b/docs/reference/indices/get-data-stream.asciidoc @@ -5,7 +5,7 @@ Get data stream ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. diff --git a/docs/reference/indices/get-field-mapping.asciidoc b/docs/reference/indices/get-field-mapping.asciidoc index aac0ae9801f41..4b25e0e925541 100644 --- a/docs/reference/indices/get-field-mapping.asciidoc +++ b/docs/reference/indices/get-field-mapping.asciidoc @@ -4,7 +4,7 @@ Get field mapping ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/get-index-template-v1.asciidoc b/docs/reference/indices/get-index-template-v1.asciidoc index 03f7e2873903e..5072a194319ef 100644 --- a/docs/reference/indices/get-index-template-v1.asciidoc +++ b/docs/reference/indices/get-index-template-v1.asciidoc @@ -8,7 +8,7 @@ IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in {es} 7.8. For information about composable templates, see <>. -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/get-index-template.asciidoc b/docs/reference/indices/get-index-template.asciidoc index a1fb974b2babf..9d27bf5b2b2a4 100644 --- a/docs/reference/indices/get-index-template.asciidoc +++ b/docs/reference/indices/get-index-template.asciidoc @@ -4,7 +4,7 @@ Get index template ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/get-index.asciidoc b/docs/reference/indices/get-index.asciidoc index 691493e078c4b..4e026f4ff07a3 100644 --- a/docs/reference/indices/get-index.asciidoc +++ b/docs/reference/indices/get-index.asciidoc @@ -4,7 +4,7 @@ Get index ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/get-mapping.asciidoc b/docs/reference/indices/get-mapping.asciidoc index 9fd02e6fba897..543bda6cb3242 100644 --- a/docs/reference/indices/get-mapping.asciidoc +++ b/docs/reference/indices/get-mapping.asciidoc @@ -4,7 +4,7 @@ Get mapping ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/get-settings.asciidoc b/docs/reference/indices/get-settings.asciidoc index 4b3929664bf11..d48514b9a3493 100644 --- a/docs/reference/indices/get-settings.asciidoc +++ b/docs/reference/indices/get-settings.asciidoc @@ -4,7 +4,7 @@ Get index settings ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/index-template-exists-v1.asciidoc b/docs/reference/indices/index-template-exists-v1.asciidoc index d9aec6f4b86c2..f7b3a4416715d 100644 --- a/docs/reference/indices/index-template-exists-v1.asciidoc +++ b/docs/reference/indices/index-template-exists-v1.asciidoc @@ -9,7 +9,7 @@ templates>>, which are deprecated and will be replaced by the composable templates introduced in {es} 7.8. For information about composable templates, see <>. -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/indices-exists.asciidoc b/docs/reference/indices/indices-exists.asciidoc index 3594619c22fcc..11da491adf8e5 100644 --- a/docs/reference/indices/indices-exists.asciidoc +++ b/docs/reference/indices/indices-exists.asciidoc @@ -4,7 +4,7 @@ Exists ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/migrate-to-data-stream.asciidoc b/docs/reference/indices/migrate-to-data-stream.asciidoc index 8c5a8d7b1376a..745e3e28683c4 100644 --- a/docs/reference/indices/migrate-to-data-stream.asciidoc +++ b/docs/reference/indices/migrate-to-data-stream.asciidoc @@ -5,7 +5,7 @@ Migrate to data stream ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. diff --git a/docs/reference/indices/open-close.asciidoc b/docs/reference/indices/open-close.asciidoc index e9502b3f83289..fe00e5a968d96 100644 --- a/docs/reference/indices/open-close.asciidoc +++ b/docs/reference/indices/open-close.asciidoc @@ -4,7 +4,7 @@ Open index ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/put-component-template.asciidoc b/docs/reference/indices/put-component-template.asciidoc index c2a75c80b9c3e..413548364d310 100644 --- a/docs/reference/indices/put-component-template.asciidoc +++ b/docs/reference/indices/put-component-template.asciidoc @@ -4,7 +4,7 @@ Create or update component template ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/put-index-template-v1.asciidoc b/docs/reference/indices/put-index-template-v1.asciidoc index 24e9835960f91..4e109551b7a93 100644 --- a/docs/reference/indices/put-index-template-v1.asciidoc +++ b/docs/reference/indices/put-index-template-v1.asciidoc @@ -8,7 +8,7 @@ IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in {es} 7.8. For information about composable templates, see <>. -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/put-index-template.asciidoc b/docs/reference/indices/put-index-template.asciidoc index 17035daeca150..fac928c4a61b0 100644 --- a/docs/reference/indices/put-index-template.asciidoc +++ b/docs/reference/indices/put-index-template.asciidoc @@ -4,7 +4,7 @@ Create or update index template ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/put-mapping.asciidoc b/docs/reference/indices/put-mapping.asciidoc index acd5df00cb77f..479bdff22a80c 100644 --- a/docs/reference/indices/put-mapping.asciidoc +++ b/docs/reference/indices/put-mapping.asciidoc @@ -4,7 +4,7 @@ Update mapping ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/recovery.asciidoc b/docs/reference/indices/recovery.asciidoc index 44094eea73f69..032ffc5c5a082 100644 --- a/docs/reference/indices/recovery.asciidoc +++ b/docs/reference/indices/recovery.asciidoc @@ -4,7 +4,7 @@ Index recovery ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/refresh.asciidoc b/docs/reference/indices/refresh.asciidoc index 60774ffd6400f..6cc78b22323c1 100644 --- a/docs/reference/indices/refresh.asciidoc +++ b/docs/reference/indices/refresh.asciidoc @@ -4,7 +4,7 @@ Refresh ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/resolve-cluster.asciidoc b/docs/reference/indices/resolve-cluster.asciidoc index fc0301916e68f..e623cb983e86b 100644 --- a/docs/reference/indices/resolve-cluster.asciidoc +++ b/docs/reference/indices/resolve-cluster.asciidoc @@ -4,7 +4,7 @@ Resolve cluster ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/resolve.asciidoc b/docs/reference/indices/resolve.asciidoc index fb6c97d9ecf42..f0b91695b0aa1 100644 --- a/docs/reference/indices/resolve.asciidoc +++ b/docs/reference/indices/resolve.asciidoc @@ -4,7 +4,7 @@ Resolve index ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/rollover-index.asciidoc b/docs/reference/indices/rollover-index.asciidoc index b15444977ba85..cc93204469b80 100644 --- a/docs/reference/indices/rollover-index.asciidoc +++ b/docs/reference/indices/rollover-index.asciidoc @@ -4,7 +4,7 @@ Rollover ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/segments.asciidoc b/docs/reference/indices/segments.asciidoc index df999ec4c8976..b2b7b244321f4 100644 --- a/docs/reference/indices/segments.asciidoc +++ b/docs/reference/indices/segments.asciidoc @@ -4,7 +4,7 @@ Index segments ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/shard-stores.asciidoc b/docs/reference/indices/shard-stores.asciidoc index b6f2aca78be0a..35f6a0915caa0 100644 --- a/docs/reference/indices/shard-stores.asciidoc +++ b/docs/reference/indices/shard-stores.asciidoc @@ -4,7 +4,7 @@ Index shard stores ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/shrink-index.asciidoc b/docs/reference/indices/shrink-index.asciidoc index 1f4e849abff1c..931731fceb49d 100644 --- a/docs/reference/indices/shrink-index.asciidoc +++ b/docs/reference/indices/shrink-index.asciidoc @@ -4,7 +4,7 @@ Shrink index ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/simulate-index.asciidoc b/docs/reference/indices/simulate-index.asciidoc index 598e4a12acb2b..414b54aa5f414 100644 --- a/docs/reference/indices/simulate-index.asciidoc +++ b/docs/reference/indices/simulate-index.asciidoc @@ -4,7 +4,7 @@ Simulate index ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/simulate-template.asciidoc b/docs/reference/indices/simulate-template.asciidoc index 57f4dd6d4ff21..298756318f6fe 100644 --- a/docs/reference/indices/simulate-template.asciidoc +++ b/docs/reference/indices/simulate-template.asciidoc @@ -4,7 +4,7 @@ Simulate template ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/split-index.asciidoc b/docs/reference/indices/split-index.asciidoc index a4ee3faa9dc20..4bda778839735 100644 --- a/docs/reference/indices/split-index.asciidoc +++ b/docs/reference/indices/split-index.asciidoc @@ -4,7 +4,7 @@ Split index ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/stats.asciidoc b/docs/reference/indices/stats.asciidoc index 486b13e478277..1370935a7cde7 100644 --- a/docs/reference/indices/stats.asciidoc +++ b/docs/reference/indices/stats.asciidoc @@ -4,7 +4,7 @@ Index stats ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/indices/update-settings.asciidoc b/docs/reference/indices/update-settings.asciidoc index ad500943a042d..dd92a922ec655 100644 --- a/docs/reference/indices/update-settings.asciidoc +++ b/docs/reference/indices/update-settings.asciidoc @@ -4,7 +4,7 @@ Update index settings ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. diff --git a/docs/reference/inference/delete-inference.asciidoc b/docs/reference/inference/delete-inference.asciidoc index a83fb1a516b80..a9dfeabcdf259 100644 --- a/docs/reference/inference/delete-inference.asciidoc +++ b/docs/reference/inference/delete-inference.asciidoc @@ -2,6 +2,12 @@ [[delete-inference-api]] === Delete {infer} API +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-inference[{infer-cap} APIs]. +-- + Deletes an {infer} endpoint. IMPORTANT: The {infer} APIs enable you to use certain services, such as built-in {ml} models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. diff --git a/docs/reference/inference/get-inference.asciidoc b/docs/reference/inference/get-inference.asciidoc index 726facd383c18..74220514eeb98 100644 --- a/docs/reference/inference/get-inference.asciidoc +++ b/docs/reference/inference/get-inference.asciidoc @@ -2,6 +2,12 @@ [[get-inference-api]] === Get {infer} API +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-inference[{infer-cap} APIs]. +-- + Retrieves {infer} endpoint information. IMPORTANT: The {infer} APIs enable you to use certain services, such as built-in {ml} models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. diff --git a/docs/reference/inference/inference-apis.asciidoc b/docs/reference/inference/inference-apis.asciidoc index 8d5ee1b7d6ba5..4593cb31ca18f 100644 --- a/docs/reference/inference/inference-apis.asciidoc +++ b/docs/reference/inference/inference-apis.asciidoc @@ -10,6 +10,12 @@ trained models. However, if you do not plan to use the {infer} APIs to use these models or if you want to use non-NLP models, use the <>. +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-inference[{infer-cap} APIs]. +-- + The {infer} APIs enable you to create {infer} endpoints and use {ml} models of different providers - such as Amazon Bedrock, Anthropic, Azure AI Studio, Cohere, Google AI, Mistral, OpenAI, or HuggingFace - as a service. Use diff --git a/docs/reference/inference/post-inference.asciidoc b/docs/reference/inference/post-inference.asciidoc index 4edefcc911e2e..07e557aa355bd 100644 --- a/docs/reference/inference/post-inference.asciidoc +++ b/docs/reference/inference/post-inference.asciidoc @@ -2,6 +2,12 @@ [[post-inference-api]] === Perform inference API +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-inference[{infer-cap} APIs]. +-- + Performs an inference task on an input text by using an {infer} endpoint. IMPORTANT: The {infer} APIs enable you to use certain services, such as built-in {ml} models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. diff --git a/docs/reference/inference/put-inference.asciidoc b/docs/reference/inference/put-inference.asciidoc index 4f82889f562d8..307efc479c329 100644 --- a/docs/reference/inference/put-inference.asciidoc +++ b/docs/reference/inference/put-inference.asciidoc @@ -2,6 +2,12 @@ [[put-inference-api]] === Create {infer} API +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-inference[{infer-cap} APIs]. +-- + Creates an {infer} endpoint to perform an {infer} task. [IMPORTANT] diff --git a/docs/reference/inference/service-alibabacloud-ai-search.asciidoc b/docs/reference/inference/service-alibabacloud-ai-search.asciidoc index c3ff40a39cd86..5a11190549ce6 100644 --- a/docs/reference/inference/service-alibabacloud-ai-search.asciidoc +++ b/docs/reference/inference/service-alibabacloud-ai-search.asciidoc @@ -1,6 +1,12 @@ [[infer-service-alibabacloud-ai-search]] === AlibabaCloud AI Search {infer} service +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-inference[{infer-cap} APIs]. +-- + Creates an {infer} endpoint to perform an {infer} task with the `alibabacloud-ai-search` service. [discrete] diff --git a/docs/reference/inference/service-amazon-bedrock.asciidoc b/docs/reference/inference/service-amazon-bedrock.asciidoc index 761777e32f8e0..ed25ce0d515b5 100644 --- a/docs/reference/inference/service-amazon-bedrock.asciidoc +++ b/docs/reference/inference/service-amazon-bedrock.asciidoc @@ -1,6 +1,12 @@ [[infer-service-amazon-bedrock]] === Amazon Bedrock {infer} service +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-inference[{infer-cap} APIs]. +-- + Creates an {infer} endpoint to perform an {infer} task with the `amazonbedrock` service. [discrete] diff --git a/docs/reference/inference/service-anthropic.asciidoc b/docs/reference/inference/service-anthropic.asciidoc index 7fb3d1d5bea34..4ce76dc1d57bd 100644 --- a/docs/reference/inference/service-anthropic.asciidoc +++ b/docs/reference/inference/service-anthropic.asciidoc @@ -1,6 +1,12 @@ [[infer-service-anthropic]] === Anthropic {infer} service +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-inference[{infer-cap} APIs]. +-- + Creates an {infer} endpoint to perform an {infer} task with the `anthropic` service. diff --git a/docs/reference/inference/service-azure-ai-studio.asciidoc b/docs/reference/inference/service-azure-ai-studio.asciidoc index dd13a3e59aae5..7ada8df1ecdaa 100644 --- a/docs/reference/inference/service-azure-ai-studio.asciidoc +++ b/docs/reference/inference/service-azure-ai-studio.asciidoc @@ -1,6 +1,12 @@ [[infer-service-azure-ai-studio]] === Azure AI studio {infer} service +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-inference[{infer-cap} APIs]. +-- + Creates an {infer} endpoint to perform an {infer} task with the `azureaistudio` service. diff --git a/docs/reference/inference/service-azure-openai.asciidoc b/docs/reference/inference/service-azure-openai.asciidoc index b134e2b687f6c..170c0939166f7 100644 --- a/docs/reference/inference/service-azure-openai.asciidoc +++ b/docs/reference/inference/service-azure-openai.asciidoc @@ -1,6 +1,12 @@ [[infer-service-azure-openai]] === Azure OpenAI {infer} service +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-inference[{infer-cap} APIs]. +-- + Creates an {infer} endpoint to perform an {infer} task with the `azureopenai` service. diff --git a/docs/reference/inference/service-cohere.asciidoc b/docs/reference/inference/service-cohere.asciidoc index 1a815e3c45f36..70e311c810cdd 100644 --- a/docs/reference/inference/service-cohere.asciidoc +++ b/docs/reference/inference/service-cohere.asciidoc @@ -1,6 +1,12 @@ [[infer-service-cohere]] === Cohere {infer} service +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-inference[{infer-cap} APIs]. +-- + Creates an {infer} endpoint to perform an {infer} task with the `cohere` service. diff --git a/docs/reference/inference/service-elasticsearch.asciidoc b/docs/reference/inference/service-elasticsearch.asciidoc index cd06e6d7b2f64..2e30e3cb498b4 100644 --- a/docs/reference/inference/service-elasticsearch.asciidoc +++ b/docs/reference/inference/service-elasticsearch.asciidoc @@ -1,6 +1,12 @@ [[infer-service-elasticsearch]] === Elasticsearch {infer} service +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-inference[{infer-cap} APIs]. +-- + Creates an {infer} endpoint to perform an {infer} task with the `elasticsearch` service. NOTE: If you use the ELSER or the E5 model through the `elasticsearch` service, the API request will automatically download and deploy the model if it isn't downloaded yet. diff --git a/docs/reference/inference/service-elser.asciidoc b/docs/reference/inference/service-elser.asciidoc index c1cc23c8c9adb..56e56215124af 100644 --- a/docs/reference/inference/service-elser.asciidoc +++ b/docs/reference/inference/service-elser.asciidoc @@ -1,6 +1,12 @@ [[infer-service-elser]] === ELSER {infer} service +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-inference[{infer-cap} APIs]. +-- + Creates an {infer} endpoint to perform an {infer} task with the `elser` service. You can also deploy ELSER by using the <>. diff --git a/docs/reference/inference/service-google-ai-studio.asciidoc b/docs/reference/inference/service-google-ai-studio.asciidoc index 738fce3d53e9b..5b30292fb9beb 100644 --- a/docs/reference/inference/service-google-ai-studio.asciidoc +++ b/docs/reference/inference/service-google-ai-studio.asciidoc @@ -1,6 +1,12 @@ [[infer-service-google-ai-studio]] === Google AI Studio {infer} service +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-inference[{infer-cap} APIs]. +-- + Creates an {infer} endpoint to perform an {infer} task with the `googleaistudio` service. diff --git a/docs/reference/inference/service-google-vertex-ai.asciidoc b/docs/reference/inference/service-google-vertex-ai.asciidoc index 34e14e05e072a..28fa65b6e5fcc 100644 --- a/docs/reference/inference/service-google-vertex-ai.asciidoc +++ b/docs/reference/inference/service-google-vertex-ai.asciidoc @@ -1,6 +1,12 @@ [[infer-service-google-vertex-ai]] === Google Vertex AI {infer} service +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-inference[{infer-cap} APIs]. +-- + Creates an {infer} endpoint to perform an {infer} task with the `googlevertexai` service. diff --git a/docs/reference/inference/service-hugging-face.asciidoc b/docs/reference/inference/service-hugging-face.asciidoc index 6d8667351a6b4..862914c141740 100644 --- a/docs/reference/inference/service-hugging-face.asciidoc +++ b/docs/reference/inference/service-hugging-face.asciidoc @@ -1,6 +1,12 @@ [[infer-service-hugging-face]] === HuggingFace {infer} service +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-inference[{infer-cap} APIs]. +-- + Creates an {infer} endpoint to perform an {infer} task with the `hugging_face` service. diff --git a/docs/reference/inference/service-mistral.asciidoc b/docs/reference/inference/service-mistral.asciidoc index 244381d107161..326e8458be767 100644 --- a/docs/reference/inference/service-mistral.asciidoc +++ b/docs/reference/inference/service-mistral.asciidoc @@ -1,6 +1,12 @@ [[infer-service-mistral]] === Mistral {infer} service +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-inference[{infer-cap} APIs]. +-- + Creates an {infer} endpoint to perform an {infer} task with the `mistral` service. diff --git a/docs/reference/inference/service-openai.asciidoc b/docs/reference/inference/service-openai.asciidoc index 9211e2d08e88b..e4be7f18e09dd 100644 --- a/docs/reference/inference/service-openai.asciidoc +++ b/docs/reference/inference/service-openai.asciidoc @@ -1,6 +1,12 @@ [[infer-service-openai]] === OpenAI {infer} service +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-inference[{infer-cap} APIs]. +-- + Creates an {infer} endpoint to perform an {infer} task with the `openai` service. diff --git a/docs/reference/inference/service-watsonx-ai.asciidoc b/docs/reference/inference/service-watsonx-ai.asciidoc index 597afc27fd0cf..e7bba7b4e9a97 100644 --- a/docs/reference/inference/service-watsonx-ai.asciidoc +++ b/docs/reference/inference/service-watsonx-ai.asciidoc @@ -1,6 +1,12 @@ [[infer-service-watsonx-ai]] === Watsonx {infer} service +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-inference[{infer-cap} APIs]. +-- + Creates an {infer} endpoint to perform an {infer} task with the `watsonxai` service. You need an https://cloud.ibm.com/docs/databases-for-elasticsearch?topic=databases-for-elasticsearch-provisioning&interface=api[IBM Cloud® Databases for Elasticsearch deployment] to use the `watsonxai` {infer} service. diff --git a/docs/reference/inference/stream-inference.asciidoc b/docs/reference/inference/stream-inference.asciidoc index e66acd630cb3e..42abb589f9afd 100644 --- a/docs/reference/inference/stream-inference.asciidoc +++ b/docs/reference/inference/stream-inference.asciidoc @@ -2,6 +2,12 @@ [[stream-inference-api]] === Stream inference API +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-inference[{infer-cap} APIs]. +-- + Streams a chat completion response. IMPORTANT: The {infer} APIs enable you to use certain services, such as built-in {ml} models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. diff --git a/docs/reference/inference/update-inference.asciidoc b/docs/reference/inference/update-inference.asciidoc index efd29231ac12e..d3a90f5d84e65 100644 --- a/docs/reference/inference/update-inference.asciidoc +++ b/docs/reference/inference/update-inference.asciidoc @@ -2,6 +2,12 @@ [[update-inference-api]] === Update inference API +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-inference[{infer-cap} APIs]. +-- + Updates an {infer} endpoint. IMPORTANT: The {infer} APIs enable you to use certain services, such as built-in {ml} models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. diff --git a/docs/reference/ingest/apis/delete-ip-location-database.asciidoc b/docs/reference/ingest/apis/delete-ip-location-database.asciidoc index c3a10a914d2f4..23f1d15bfa7ee 100644 --- a/docs/reference/ingest/apis/delete-ip-location-database.asciidoc +++ b/docs/reference/ingest/apis/delete-ip-location-database.asciidoc @@ -4,6 +4,12 @@ Delete IP geolocation database configuration ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ingest[Ingest APIs]. +-- + Deletes a IP geolocation database configuration. [source,console] diff --git a/docs/reference/ingest/apis/delete-pipeline.asciidoc b/docs/reference/ingest/apis/delete-pipeline.asciidoc index 94ac87c61b56b..cd4cae1b636ca 100644 --- a/docs/reference/ingest/apis/delete-pipeline.asciidoc +++ b/docs/reference/ingest/apis/delete-pipeline.asciidoc @@ -4,6 +4,12 @@ Delete pipeline ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ingest[Ingest APIs]. +-- + Deletes one or more existing ingest pipeline. //// diff --git a/docs/reference/ingest/apis/enrich/delete-enrich-policy.asciidoc b/docs/reference/ingest/apis/enrich/delete-enrich-policy.asciidoc index d190322fbfe9f..cd68bd1fcc67b 100644 --- a/docs/reference/ingest/apis/enrich/delete-enrich-policy.asciidoc +++ b/docs/reference/ingest/apis/enrich/delete-enrich-policy.asciidoc @@ -5,7 +5,7 @@ Delete enrich policy ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-enrich[Enrich APIs]. diff --git a/docs/reference/ingest/apis/enrich/execute-enrich-policy.asciidoc b/docs/reference/ingest/apis/enrich/execute-enrich-policy.asciidoc index 312cb2593f1f6..8e72a51514a59 100644 --- a/docs/reference/ingest/apis/enrich/execute-enrich-policy.asciidoc +++ b/docs/reference/ingest/apis/enrich/execute-enrich-policy.asciidoc @@ -5,7 +5,7 @@ Execute enrich policy ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-enrich[Enrich APIs]. diff --git a/docs/reference/ingest/apis/enrich/get-enrich-policy.asciidoc b/docs/reference/ingest/apis/enrich/get-enrich-policy.asciidoc index 48448f5925041..2f9e069d5e43d 100644 --- a/docs/reference/ingest/apis/enrich/get-enrich-policy.asciidoc +++ b/docs/reference/ingest/apis/enrich/get-enrich-policy.asciidoc @@ -5,7 +5,7 @@ Get enrich policy ++++ -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-enrich[Enrich APIs]. diff --git a/docs/reference/ingest/apis/enrich/index.asciidoc b/docs/reference/ingest/apis/enrich/index.asciidoc index 0488d535000ec..7566b8812ec3c 100644 --- a/docs/reference/ingest/apis/enrich/index.asciidoc +++ b/docs/reference/ingest/apis/enrich/index.asciidoc @@ -2,7 +2,7 @@ [[enrich-apis]] == Enrich APIs -..New API reference +.New API reference [sidebar] -- For the most up-to-date API details, refer to {api-es}/group/endpoint-enrich[Enrich APIs]. diff --git a/docs/reference/ingest/apis/geoip-stats.asciidoc b/docs/reference/ingest/apis/geoip-stats.asciidoc index 6135b7821f2a5..423fee1c5bceb 100644 --- a/docs/reference/ingest/apis/geoip-stats.asciidoc +++ b/docs/reference/ingest/apis/geoip-stats.asciidoc @@ -4,6 +4,12 @@ GeoIP stats ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ingest[Ingest APIs]. +-- + Gets statistics about the <>, including download statistics for GeoIP2 databases used with it. diff --git a/docs/reference/ingest/apis/get-ip-location-database.asciidoc b/docs/reference/ingest/apis/get-ip-location-database.asciidoc index 26e9ddc1eee50..25f1c7ffdf695 100644 --- a/docs/reference/ingest/apis/get-ip-location-database.asciidoc +++ b/docs/reference/ingest/apis/get-ip-location-database.asciidoc @@ -4,6 +4,12 @@ Get IP geolocation database configuration ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ingest[Ingest APIs]. +-- + Returns information about one or more IP geolocation database configurations. [source,console] diff --git a/docs/reference/ingest/apis/get-pipeline.asciidoc b/docs/reference/ingest/apis/get-pipeline.asciidoc index f2a1155bca12b..88fc22590004b 100644 --- a/docs/reference/ingest/apis/get-pipeline.asciidoc +++ b/docs/reference/ingest/apis/get-pipeline.asciidoc @@ -4,6 +4,12 @@ Get pipeline ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ingest[Ingest APIs]. +-- + Returns information about one or more ingest pipelines. This API returns a local reference of the pipeline. diff --git a/docs/reference/ingest/apis/index.asciidoc b/docs/reference/ingest/apis/index.asciidoc index 35adc47821978..e83131b554452 100644 --- a/docs/reference/ingest/apis/index.asciidoc +++ b/docs/reference/ingest/apis/index.asciidoc @@ -1,6 +1,12 @@ [[ingest-apis]] == Ingest APIs +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ingest[Ingest APIs]. +-- + Use ingest APIs to manage tasks and resources related to <> and processors. diff --git a/docs/reference/ingest/apis/put-ip-location-database.asciidoc b/docs/reference/ingest/apis/put-ip-location-database.asciidoc index e42d84752694c..1cdd789008881 100644 --- a/docs/reference/ingest/apis/put-ip-location-database.asciidoc +++ b/docs/reference/ingest/apis/put-ip-location-database.asciidoc @@ -4,6 +4,12 @@ Create or update IP geolocation database configuration ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ingest[Ingest APIs]. +-- + Creates or updates an IP geolocation database configuration. IMPORTANT: The Maxmind `account_id` shown below requires a license key. Because the license key is sensitive information, diff --git a/docs/reference/ingest/apis/put-pipeline.asciidoc b/docs/reference/ingest/apis/put-pipeline.asciidoc index 5b532dedf8e82..7d9854a55758d 100644 --- a/docs/reference/ingest/apis/put-pipeline.asciidoc +++ b/docs/reference/ingest/apis/put-pipeline.asciidoc @@ -4,6 +4,12 @@ Create or update pipeline ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ingest[Ingest APIs]. +-- + Creates or updates an <>. Changes made using this API take effect immediately. diff --git a/docs/reference/ingest/apis/simulate-ingest.asciidoc b/docs/reference/ingest/apis/simulate-ingest.asciidoc index da591eed7546f..a9c7e43e041bc 100644 --- a/docs/reference/ingest/apis/simulate-ingest.asciidoc +++ b/docs/reference/ingest/apis/simulate-ingest.asciidoc @@ -5,6 +5,12 @@ Simulate ingest ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ingest[Ingest APIs]. +-- + Executes ingest pipelines against a set of provided documents, optionally with substitute pipeline definitions. This API is meant to be used for troubleshooting or pipeline development, as it does not actually index any diff --git a/docs/reference/ingest/apis/simulate-pipeline.asciidoc b/docs/reference/ingest/apis/simulate-pipeline.asciidoc index bb7c343383132..fe7e5f2e91c6a 100644 --- a/docs/reference/ingest/apis/simulate-pipeline.asciidoc +++ b/docs/reference/ingest/apis/simulate-pipeline.asciidoc @@ -5,6 +5,12 @@ Simulate pipeline ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ingest[Ingest APIs]. +-- + Executes an ingest pipeline against a set of provided documents. diff --git a/docs/reference/licensing/delete-license.asciidoc b/docs/reference/licensing/delete-license.asciidoc index 0f0aac416ccf8..fd9236664e1c0 100644 --- a/docs/reference/licensing/delete-license.asciidoc +++ b/docs/reference/licensing/delete-license.asciidoc @@ -5,6 +5,12 @@ Delete license ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-license[Licensing APIs]. +-- + This API enables you to delete licensing information. [discrete] diff --git a/docs/reference/licensing/get-basic-status.asciidoc b/docs/reference/licensing/get-basic-status.asciidoc index 44bc246e72bc3..0e354e0dc07cd 100644 --- a/docs/reference/licensing/get-basic-status.asciidoc +++ b/docs/reference/licensing/get-basic-status.asciidoc @@ -5,6 +5,12 @@ Get basic status ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-license[Licensing APIs]. +-- + This API enables you to check the status of your basic license. [discrete] diff --git a/docs/reference/licensing/get-license.asciidoc b/docs/reference/licensing/get-license.asciidoc index 816bdd36ff4bd..1b50a5be8fa20 100644 --- a/docs/reference/licensing/get-license.asciidoc +++ b/docs/reference/licensing/get-license.asciidoc @@ -5,6 +5,12 @@ Get license ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-license[Licensing APIs]. +-- + This API enables you to retrieve licensing information. [discrete] diff --git a/docs/reference/licensing/get-trial-status.asciidoc b/docs/reference/licensing/get-trial-status.asciidoc index 912d90bde850f..b0ae110faa8cc 100644 --- a/docs/reference/licensing/get-trial-status.asciidoc +++ b/docs/reference/licensing/get-trial-status.asciidoc @@ -5,6 +5,12 @@ Get trial status ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-license[Licensing APIs]. +-- + Enables you to check the status of your trial. [discrete] diff --git a/docs/reference/licensing/index.asciidoc b/docs/reference/licensing/index.asciidoc index a1dfd398acfe7..12df7b606c5bd 100644 --- a/docs/reference/licensing/index.asciidoc +++ b/docs/reference/licensing/index.asciidoc @@ -2,6 +2,12 @@ [[licensing-apis]] == Licensing APIs +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-license[Licensing APIs]. +-- + You can use the following APIs to manage your licenses: * <> diff --git a/docs/reference/licensing/start-basic.asciidoc b/docs/reference/licensing/start-basic.asciidoc index 8ae25e1940a62..291a0ec452caf 100644 --- a/docs/reference/licensing/start-basic.asciidoc +++ b/docs/reference/licensing/start-basic.asciidoc @@ -5,6 +5,12 @@ Start basic ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-license[Licensing APIs]. +-- + This API starts an indefinite basic license. [discrete] diff --git a/docs/reference/licensing/update-license.asciidoc b/docs/reference/licensing/update-license.asciidoc index 4207dbb092fb0..03b6c3ce40edd 100644 --- a/docs/reference/licensing/update-license.asciidoc +++ b/docs/reference/licensing/update-license.asciidoc @@ -5,6 +5,12 @@ Update license ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-license[Licensing APIs]. +-- + Updates the license for your {es} cluster. [[update-license-api-request]] diff --git a/docs/reference/migration/apis/deprecation.asciidoc b/docs/reference/migration/apis/deprecation.asciidoc index 67b4c113af2bc..71453a001eeeb 100644 --- a/docs/reference/migration/apis/deprecation.asciidoc +++ b/docs/reference/migration/apis/deprecation.asciidoc @@ -5,6 +5,12 @@ Deprecation info ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-migration[Migration APIs]. +-- + include::{es-ref-dir}/migration/apis/shared-migration-apis-tip.asciidoc[] The deprecation API is to be used to retrieve information about different diff --git a/docs/reference/migration/apis/feature-migration.asciidoc b/docs/reference/migration/apis/feature-migration.asciidoc index e38639ac44531..717a46442bd92 100644 --- a/docs/reference/migration/apis/feature-migration.asciidoc +++ b/docs/reference/migration/apis/feature-migration.asciidoc @@ -5,6 +5,12 @@ Feature migration ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-migration[Migration APIs]. +-- + include::{es-ref-dir}/migration/apis/shared-migration-apis-tip.asciidoc[] Version upgrades sometimes require changes to how features store configuration diff --git a/docs/reference/migration/migration.asciidoc b/docs/reference/migration/migration.asciidoc index ffb2ca7a7859d..57b6c88aefea4 100644 --- a/docs/reference/migration/migration.asciidoc +++ b/docs/reference/migration/migration.asciidoc @@ -2,6 +2,12 @@ [[migration-api]] == Migration APIs +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-migration[Migration APIs]. +-- + The migration APIs power {kib}'s **Upgrade Assistant** feature. include::apis/shared-migration-apis-tip.asciidoc[] diff --git a/docs/reference/ml/anomaly-detection/apis/close-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/close-job.asciidoc index f0cb968e082c5..865213dad3f50 100644 --- a/docs/reference/ml/anomaly-detection/apis/close-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/close-job.asciidoc @@ -5,6 +5,12 @@ Close jobs ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Closes one or more {anomaly-jobs}. [[ml-close-job-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/delete-calendar-event.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-calendar-event.asciidoc index b80a248038aea..d67f7cce9d1f6 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-calendar-event.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-calendar-event.asciidoc @@ -5,6 +5,12 @@ Delete events from calendar ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Deletes scheduled events from a calendar. [[ml-delete-calendar-event-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/delete-calendar-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-calendar-job.asciidoc index 6720e236fd635..17a581f964f54 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-calendar-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-calendar-job.asciidoc @@ -5,6 +5,12 @@ Delete jobs from calendar ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Deletes {anomaly-jobs} from a calendar. [[ml-delete-calendar-job-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/delete-calendar.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-calendar.asciidoc index 6684366c6f336..23ce74c8fb310 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-calendar.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-calendar.asciidoc @@ -5,6 +5,12 @@ Delete calendars ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Deletes a calendar. [[ml-delete-calendar-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/delete-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-datafeed.asciidoc index 64a1e4c336fe6..61d3624ef50dc 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-datafeed.asciidoc @@ -7,6 +7,12 @@ Delete {dfeeds} ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Deletes an existing {dfeed}. [[ml-delete-datafeed-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/delete-expired-data.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-expired-data.asciidoc index a8c1279ac1b47..bee453f8d2082 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-expired-data.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-expired-data.asciidoc @@ -5,6 +5,12 @@ Delete expired data ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Deletes expired and unused machine learning data. [[ml-delete-expired-data-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/delete-filter.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-filter.asciidoc index 4b41347543e8e..84346ae012300 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-filter.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-filter.asciidoc @@ -5,6 +5,12 @@ Delete filters ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Deletes a filter. [[ml-delete-filter-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/delete-forecast.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-forecast.asciidoc index 74e6ce27084ad..ee3167036f66d 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-forecast.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-forecast.asciidoc @@ -5,6 +5,12 @@ Delete forecasts ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Deletes forecasts from a {ml} job. [[ml-delete-forecast-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/delete-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-job.asciidoc index 1bbe07fd44f49..595c5acc041d6 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-job.asciidoc @@ -5,6 +5,12 @@ Delete jobs ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Deletes an existing {anomaly-job}. [[ml-delete-job-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/delete-snapshot.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-snapshot.asciidoc index ad10de7a2ba0f..345b933a19622 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-snapshot.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-snapshot.asciidoc @@ -5,6 +5,12 @@ Delete model snapshots ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Deletes an existing model snapshot. [[ml-delete-snapshot-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/estimate-model-memory.asciidoc b/docs/reference/ml/anomaly-detection/apis/estimate-model-memory.asciidoc index 1cc4df42f083d..8be8e8df72d4e 100644 --- a/docs/reference/ml/anomaly-detection/apis/estimate-model-memory.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/estimate-model-memory.asciidoc @@ -5,6 +5,12 @@ Estimate model memory ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Makes an estimation of the memory usage for an {anomaly-job} model. It is based on analysis configuration details for the job and cardinality estimates for the fields it references. diff --git a/docs/reference/ml/anomaly-detection/apis/flush-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/flush-job.asciidoc index 68ff601749b4b..dcf4d7a6b1d60 100644 --- a/docs/reference/ml/anomaly-detection/apis/flush-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/flush-job.asciidoc @@ -5,6 +5,12 @@ Flush jobs ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Forces any buffered data to be processed by the job. [[ml-flush-job-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/forecast.asciidoc b/docs/reference/ml/anomaly-detection/apis/forecast.asciidoc index 3e6067ab05857..ac4e3eb4ed29a 100644 --- a/docs/reference/ml/anomaly-detection/apis/forecast.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/forecast.asciidoc @@ -5,6 +5,12 @@ Forecast jobs ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Predicts the future behavior of a time series by using its historical behavior. [[ml-forecast-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/get-bucket.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-bucket.asciidoc index bca839d1db318..d33d6f64021a3 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-bucket.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-bucket.asciidoc @@ -5,6 +5,12 @@ Get buckets ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Retrieves {anomaly-job} results for one or more buckets. [[ml-get-bucket-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/get-calendar-event.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-calendar-event.asciidoc index fc06e286bf46c..565a553e18974 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-calendar-event.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-calendar-event.asciidoc @@ -5,6 +5,12 @@ Get scheduled events ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Retrieves information about the scheduled events in calendars. [[ml-get-calendar-event-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/get-calendar.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-calendar.asciidoc index b2c46bbe16c0e..bf00458299633 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-calendar.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-calendar.asciidoc @@ -5,6 +5,12 @@ Get calendars ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Retrieves configuration information for calendars. [[ml-get-calendar-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/get-category.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-category.asciidoc index 33de5e0f71a08..0f5fa1504c9fe 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-category.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-category.asciidoc @@ -5,6 +5,12 @@ Get categories ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Retrieves {anomaly-job} results for one or more categories. [[ml-get-category-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/get-datafeed-stats.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-datafeed-stats.asciidoc index a224f3880a1ad..950d12e9a503f 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-datafeed-stats.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-datafeed-stats.asciidoc @@ -7,6 +7,12 @@ Get {dfeed} statistics ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Retrieves usage information for {dfeeds}. [[ml-get-datafeed-stats-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/get-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-datafeed.asciidoc index a986e2220f928..3b86c5cc22a87 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-datafeed.asciidoc @@ -7,6 +7,12 @@ Get {dfeeds} ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Retrieves configuration information for {dfeeds}. [[ml-get-datafeed-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/get-filter.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-filter.asciidoc index f73dcd236f1af..dc167238701cd 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-filter.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-filter.asciidoc @@ -5,6 +5,12 @@ Get filters ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Retrieves filters. [[ml-get-filter-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/get-influencer.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-influencer.asciidoc index 31489e361a848..f2e26344207a8 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-influencer.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-influencer.asciidoc @@ -5,6 +5,12 @@ Get influencers ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Retrieves {anomaly-job} results for one or more influencers. [[ml-get-influencer-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/get-job-model-snapshot-upgrade-stats.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-job-model-snapshot-upgrade-stats.asciidoc index 0939282a75916..32a9b67258b2d 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-job-model-snapshot-upgrade-stats.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-job-model-snapshot-upgrade-stats.asciidoc @@ -7,6 +7,12 @@ Get model snapshot upgrade statistics ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Retrieves usage information for {anomaly-job} model snapshot upgrades. [[ml-get-job-model-snapshot-upgrade-stats-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc index a5bd188397bb9..a3c329edb3d83 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-job-stats.asciidoc @@ -5,6 +5,12 @@ Get job statistics ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Retrieves usage information for {anomaly-jobs}. [[ml-get-job-stats-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/get-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-job.asciidoc index 4ee6c429ce730..8331be16df82a 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-job.asciidoc @@ -5,6 +5,12 @@ Get jobs ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Retrieves configuration information for {anomaly-jobs}. [[ml-get-job-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/get-overall-buckets.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-overall-buckets.asciidoc index b581b5c3a2eb2..45ae61647bfda 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-overall-buckets.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-overall-buckets.asciidoc @@ -5,6 +5,12 @@ Get overall buckets ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Retrieves overall bucket results that summarize the bucket results of multiple {anomaly-jobs}. diff --git a/docs/reference/ml/anomaly-detection/apis/get-record.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-record.asciidoc index e74ab3ecb4b12..266ab64ba5e19 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-record.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-record.asciidoc @@ -5,6 +5,12 @@ Get records ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Retrieves anomaly records for an {anomaly-job}. [[ml-get-record-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/get-snapshot.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-snapshot.asciidoc index d94bd4060854a..47fdc3db46b60 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-snapshot.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-snapshot.asciidoc @@ -5,6 +5,12 @@ Get model snapshots ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Retrieves information about model snapshots. [[ml-get-snapshot-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/ml-ad-apis.asciidoc b/docs/reference/ml/anomaly-detection/apis/ml-ad-apis.asciidoc index 856232c933432..951f9522db74b 100644 --- a/docs/reference/ml/anomaly-detection/apis/ml-ad-apis.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/ml-ad-apis.asciidoc @@ -2,6 +2,12 @@ [[ml-ad-apis]] = {ml-cap} {anomaly-detect} APIs +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + You can use the following APIs to perform {ml} {anomaly-detect} activities. See also <>, <>, <>. diff --git a/docs/reference/ml/anomaly-detection/apis/open-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/open-job.asciidoc index 385f672f467f6..9a5153952b5a2 100644 --- a/docs/reference/ml/anomaly-detection/apis/open-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/open-job.asciidoc @@ -5,6 +5,12 @@ Open jobs ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Opens one or more {anomaly-jobs}. [[ml-open-job-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/post-calendar-event.asciidoc b/docs/reference/ml/anomaly-detection/apis/post-calendar-event.asciidoc index 8db1eb1ae84df..a717d76ea4e55 100644 --- a/docs/reference/ml/anomaly-detection/apis/post-calendar-event.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/post-calendar-event.asciidoc @@ -5,6 +5,12 @@ Add events to calendar ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Posts scheduled events in a calendar. [[ml-post-calendar-event-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/post-data.asciidoc b/docs/reference/ml/anomaly-detection/apis/post-data.asciidoc index 931efcf8c2a52..83e5dd77e814a 100644 --- a/docs/reference/ml/anomaly-detection/apis/post-data.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/post-data.asciidoc @@ -7,6 +7,12 @@ deprecated::[7.11.0, "Posting data directly to anomaly detection jobs is deprecated, in a future major version a <> will be required."] +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Sends data to an anomaly detection job for analysis. [[ml-post-data-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/preview-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/preview-datafeed.asciidoc index 243cd2a5f32a3..c57965401e074 100644 --- a/docs/reference/ml/anomaly-detection/apis/preview-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/preview-datafeed.asciidoc @@ -7,6 +7,12 @@ Preview {dfeeds} ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Previews a {dfeed}. [[ml-preview-datafeed-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/put-calendar-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/put-calendar-job.asciidoc index 0c19a08cbd74b..612f472bba37d 100644 --- a/docs/reference/ml/anomaly-detection/apis/put-calendar-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/put-calendar-job.asciidoc @@ -5,6 +5,12 @@ Add jobs to calendar ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Adds an {anomaly-job} to a calendar. [[ml-put-calendar-job-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/put-calendar.asciidoc b/docs/reference/ml/anomaly-detection/apis/put-calendar.asciidoc index fd2b58a31737a..69a4498cc29da 100644 --- a/docs/reference/ml/anomaly-detection/apis/put-calendar.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/put-calendar.asciidoc @@ -5,6 +5,12 @@ Create calendars ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Instantiates a calendar. [[ml-put-calendar-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/put-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/put-datafeed.asciidoc index 47e3059666d76..18260d3538e4b 100644 --- a/docs/reference/ml/anomaly-detection/apis/put-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/put-datafeed.asciidoc @@ -7,6 +7,12 @@ Create {dfeeds} ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Instantiates a {dfeed}. [[ml-put-datafeed-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/put-filter.asciidoc b/docs/reference/ml/anomaly-detection/apis/put-filter.asciidoc index b50ba8cb1e23b..3f3157f008e9f 100644 --- a/docs/reference/ml/anomaly-detection/apis/put-filter.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/put-filter.asciidoc @@ -5,6 +5,12 @@ Create filters ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Instantiates a filter. [[ml-put-filter-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/put-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/put-job.asciidoc index 7bf02e7a0dd6e..e3c292cc534bf 100644 --- a/docs/reference/ml/anomaly-detection/apis/put-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/put-job.asciidoc @@ -5,6 +5,12 @@ Create jobs ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Instantiates an {anomaly-job}. [[ml-put-job-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/reset-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/reset-job.asciidoc index 9009d634a2e9c..2d9c4696cab4b 100644 --- a/docs/reference/ml/anomaly-detection/apis/reset-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/reset-job.asciidoc @@ -5,6 +5,12 @@ Reset jobs ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Resets an existing {anomaly-job}. [[ml-reset-job-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/revert-snapshot.asciidoc b/docs/reference/ml/anomaly-detection/apis/revert-snapshot.asciidoc index c8d7a27ee2047..792a102ff2953 100644 --- a/docs/reference/ml/anomaly-detection/apis/revert-snapshot.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/revert-snapshot.asciidoc @@ -5,6 +5,12 @@ Revert model snapshots ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Reverts to a specific snapshot. [[ml-revert-snapshot-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/start-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/start-datafeed.asciidoc index b54c80133d7dc..4281b3a02b826 100644 --- a/docs/reference/ml/anomaly-detection/apis/start-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/start-datafeed.asciidoc @@ -7,6 +7,12 @@ Start {dfeeds} ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Starts one or more {dfeeds}. [[ml-start-datafeed-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/stop-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/stop-datafeed.asciidoc index bc15a1de8a056..91e5087715fb7 100644 --- a/docs/reference/ml/anomaly-detection/apis/stop-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/stop-datafeed.asciidoc @@ -7,6 +7,12 @@ Stop {dfeeds} ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Stops one or more {dfeeds}. [[ml-stop-datafeed-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/update-datafeed.asciidoc b/docs/reference/ml/anomaly-detection/apis/update-datafeed.asciidoc index b3920d9d4f809..c03c921e7875a 100644 --- a/docs/reference/ml/anomaly-detection/apis/update-datafeed.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/update-datafeed.asciidoc @@ -7,6 +7,12 @@ Update {dfeeds} ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Updates certain properties of a {dfeed}. diff --git a/docs/reference/ml/anomaly-detection/apis/update-filter.asciidoc b/docs/reference/ml/anomaly-detection/apis/update-filter.asciidoc index a4221c37a438e..8fb5376f4acbc 100644 --- a/docs/reference/ml/anomaly-detection/apis/update-filter.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/update-filter.asciidoc @@ -5,6 +5,12 @@ Update filters ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Updates the description of a filter, adds items, or removes items. [[ml-update-filter-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/update-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/update-job.asciidoc index ee13247fc8838..bed013c113c01 100644 --- a/docs/reference/ml/anomaly-detection/apis/update-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/update-job.asciidoc @@ -5,6 +5,12 @@ Update jobs ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Updates certain properties of an {anomaly-job}. [[ml-update-job-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/update-snapshot.asciidoc b/docs/reference/ml/anomaly-detection/apis/update-snapshot.asciidoc index f8c0384860029..54276f62ff094 100644 --- a/docs/reference/ml/anomaly-detection/apis/update-snapshot.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/update-snapshot.asciidoc @@ -5,6 +5,12 @@ Update model snapshots ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Updates certain properties of a snapshot. [[ml-update-snapshot-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/upgrade-job-model-snapshot.asciidoc b/docs/reference/ml/anomaly-detection/apis/upgrade-job-model-snapshot.asciidoc index 3a74e3b2296df..2538b4958ada1 100644 --- a/docs/reference/ml/anomaly-detection/apis/upgrade-job-model-snapshot.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/upgrade-job-model-snapshot.asciidoc @@ -5,6 +5,12 @@ Upgrade model snapshots ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Upgrades an {anomaly-detect} model snapshot to the latest major version. NOTE: From {es} 8.10.0, a new version number is used to diff --git a/docs/reference/ml/anomaly-detection/apis/validate-detector.asciidoc b/docs/reference/ml/anomaly-detection/apis/validate-detector.asciidoc index c71673be7dc00..820845d0fd233 100644 --- a/docs/reference/ml/anomaly-detection/apis/validate-detector.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/validate-detector.asciidoc @@ -5,6 +5,12 @@ Validate detectors ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Validates detector configuration information. [[ml-valid-detector-request]] diff --git a/docs/reference/ml/anomaly-detection/apis/validate-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/validate-job.asciidoc index c77623566d4c8..382199e315695 100644 --- a/docs/reference/ml/anomaly-detection/apis/validate-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/validate-job.asciidoc @@ -5,6 +5,12 @@ Validate jobs ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-anomaly[{ml-cap} {anomaly-detect} APIs]. +-- + Validates {anomaly-job} configuration information. [[ml-valid-job-request]] diff --git a/docs/reference/ml/common/apis/get-ml-info.asciidoc b/docs/reference/ml/common/apis/get-ml-info.asciidoc index 104375bd641c8..62fae2a9a9184 100644 --- a/docs/reference/ml/common/apis/get-ml-info.asciidoc +++ b/docs/reference/ml/common/apis/get-ml-info.asciidoc @@ -7,6 +7,12 @@ Get {ml} info ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml[{ml-cap} APIs]. +-- + Returns defaults and limits used by machine learning. [[get-ml-info-request]] diff --git a/docs/reference/ml/common/apis/get-ml-memory.asciidoc b/docs/reference/ml/common/apis/get-ml-memory.asciidoc index 81e0f59a97e58..8c1cf620b70eb 100644 --- a/docs/reference/ml/common/apis/get-ml-memory.asciidoc +++ b/docs/reference/ml/common/apis/get-ml-memory.asciidoc @@ -7,6 +7,12 @@ Get {ml} memory stats ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml[{ml-cap} APIs]. +-- + Returns information on how {ml} is using memory. [[get-ml-memory-request]] diff --git a/docs/reference/ml/common/apis/ml-apis.asciidoc b/docs/reference/ml/common/apis/ml-apis.asciidoc index c4349f3eb7366..95f102ceecfa8 100644 --- a/docs/reference/ml/common/apis/ml-apis.asciidoc +++ b/docs/reference/ml/common/apis/ml-apis.asciidoc @@ -2,6 +2,12 @@ [[ml-apis]] = {ml-cap} APIs +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml[{ml-cap} APIs]. +-- + You can use the following APIs to retrieve information related to the {stack-ml-features}: diff --git a/docs/reference/ml/common/apis/set-upgrade-mode.asciidoc b/docs/reference/ml/common/apis/set-upgrade-mode.asciidoc index 2469753382f9b..52adcac9bacdc 100644 --- a/docs/reference/ml/common/apis/set-upgrade-mode.asciidoc +++ b/docs/reference/ml/common/apis/set-upgrade-mode.asciidoc @@ -5,6 +5,12 @@ Set upgrade mode ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml[{ml-cap} APIs]. +-- + Sets a cluster wide upgrade_mode setting that prepares {ml} indices for an upgrade. diff --git a/docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc index b505da570244f..a6b5058eab887 100644 --- a/docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc @@ -6,6 +6,12 @@ Delete {dfanalytics-jobs} ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-data-frame[{ml-cap} {dfanalytics} APIs]. +-- + Deletes an existing {dfanalytics-job}. diff --git a/docs/reference/ml/df-analytics/apis/evaluate-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/evaluate-dfanalytics.asciidoc index 8d31fcd0107d9..fb0b6da0bc805 100644 --- a/docs/reference/ml/df-analytics/apis/evaluate-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/evaluate-dfanalytics.asciidoc @@ -7,6 +7,12 @@ Evaluate {dfanalytics} ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-data-frame[{ml-cap} {dfanalytics} APIs]. +-- + Evaluates the {dfanalytics} for an annotated index. diff --git a/docs/reference/ml/df-analytics/apis/explain-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/explain-dfanalytics.asciidoc index 0ee7ec5634582..566cfc3ba3596 100644 --- a/docs/reference/ml/df-analytics/apis/explain-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/explain-dfanalytics.asciidoc @@ -7,6 +7,12 @@ Explain {dfanalytics} ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-data-frame[{ml-cap} {dfanalytics} APIs]. +-- + Explains a {dataframe-analytics-config}. diff --git a/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc b/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc index b193379084db1..e0cdfc40de4c0 100644 --- a/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc +++ b/docs/reference/ml/df-analytics/apis/get-dfanalytics-stats.asciidoc @@ -6,8 +6,13 @@ Get {dfanalytics-jobs} stats ++++ -Retrieves usage information for {dfanalytics-jobs}. +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-data-frame[{ml-cap} {dfanalytics} APIs]. +-- +Retrieves usage information for {dfanalytics-jobs}. [[ml-get-dfanalytics-stats-request]] == {api-request-title} diff --git a/docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc index c2a4caa981da1..6e65bdfe83a25 100644 --- a/docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/get-dfanalytics.asciidoc @@ -5,6 +5,12 @@ Get {dfanalytics-jobs} ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-data-frame[{ml-cap} {dfanalytics} APIs]. +-- + Retrieves configuration information for {dfanalytics-jobs}. diff --git a/docs/reference/ml/df-analytics/apis/ml-df-analytics-apis.asciidoc b/docs/reference/ml/df-analytics/apis/ml-df-analytics-apis.asciidoc index ba16f728e4b9a..a90f42b7b9757 100644 --- a/docs/reference/ml/df-analytics/apis/ml-df-analytics-apis.asciidoc +++ b/docs/reference/ml/df-analytics/apis/ml-df-analytics-apis.asciidoc @@ -2,6 +2,12 @@ [[ml-df-analytics-apis]] = {ml-cap} {dfanalytics} APIs +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-data-frame[{ml-cap} {dfanalytics} APIs]. +-- + You can use the following APIs to perform {ml} {dfanalytics} activities: * <> diff --git a/docs/reference/ml/df-analytics/apis/preview-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/preview-dfanalytics.asciidoc index 2c61c3263992c..896cf5ca8eb8a 100644 --- a/docs/reference/ml/df-analytics/apis/preview-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/preview-dfanalytics.asciidoc @@ -7,6 +7,12 @@ Preview {dfanalytics} ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-data-frame[{ml-cap} {dfanalytics} APIs]. +-- + Previews the features used by a {dataframe-analytics-config}. diff --git a/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc index 54cbe78b34452..8c2e95e0744ed 100644 --- a/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc @@ -6,6 +6,12 @@ Create {dfanalytics-jobs} ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-data-frame[{ml-cap} {dfanalytics} APIs]. +-- + Instantiates a {dfanalytics-job}. diff --git a/docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc index 70e996ef8dd0a..7409c443ff802 100644 --- a/docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/start-dfanalytics.asciidoc @@ -7,6 +7,12 @@ Start {dfanalytics-jobs} ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-data-frame[{ml-cap} {dfanalytics} APIs]. +-- + Starts a {dfanalytics-job}. diff --git a/docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc index 2fa3bc4413d7a..95d39b98e3bbd 100644 --- a/docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/stop-dfanalytics.asciidoc @@ -7,6 +7,12 @@ Stop {dfanalytics-jobs} ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-data-frame[{ml-cap} {dfanalytics} APIs]. +-- + Stops one or more {dfanalytics-jobs}. diff --git a/docs/reference/ml/df-analytics/apis/update-dfanalytics.asciidoc b/docs/reference/ml/df-analytics/apis/update-dfanalytics.asciidoc index 49cca176be69b..35e871761b21a 100644 --- a/docs/reference/ml/df-analytics/apis/update-dfanalytics.asciidoc +++ b/docs/reference/ml/df-analytics/apis/update-dfanalytics.asciidoc @@ -6,6 +6,12 @@ Update {dfanalytics-jobs} ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-data-frame[{ml-cap} {dfanalytics} APIs]. +-- + Updates an existing {dfanalytics-job}. diff --git a/docs/reference/ml/trained-models/apis/clear-trained-model-deployment-cache.asciidoc b/docs/reference/ml/trained-models/apis/clear-trained-model-deployment-cache.asciidoc index f24379705fc75..1e1639ab5eee2 100644 --- a/docs/reference/ml/trained-models/apis/clear-trained-model-deployment-cache.asciidoc +++ b/docs/reference/ml/trained-models/apis/clear-trained-model-deployment-cache.asciidoc @@ -6,6 +6,12 @@ Clear trained model deployment cache ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-trained-model[{ml-cap} trained model APIs]. +-- + Clears the {infer} cache on all nodes where the deployment is assigned. [[clear-trained-model-deployment-cache-request]] diff --git a/docs/reference/ml/trained-models/apis/delete-trained-models-aliases.asciidoc b/docs/reference/ml/trained-models/apis/delete-trained-models-aliases.asciidoc index 1b67a642f7b7a..22e0422df9fb7 100644 --- a/docs/reference/ml/trained-models/apis/delete-trained-models-aliases.asciidoc +++ b/docs/reference/ml/trained-models/apis/delete-trained-models-aliases.asciidoc @@ -6,6 +6,12 @@ Delete trained model aliases ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-trained-model[{ml-cap} trained model APIs]. +-- + Deletes a trained model alias. diff --git a/docs/reference/ml/trained-models/apis/delete-trained-models.asciidoc b/docs/reference/ml/trained-models/apis/delete-trained-models.asciidoc index 1b54343d1f1c9..d738c6630a78f 100644 --- a/docs/reference/ml/trained-models/apis/delete-trained-models.asciidoc +++ b/docs/reference/ml/trained-models/apis/delete-trained-models.asciidoc @@ -6,6 +6,12 @@ Delete trained models ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-trained-model[{ml-cap} trained model APIs]. +-- + Deletes an existing trained {infer} model. diff --git a/docs/reference/ml/trained-models/apis/get-trained-models-stats.asciidoc b/docs/reference/ml/trained-models/apis/get-trained-models-stats.asciidoc index b55f022a5d168..82263c98e9112 100644 --- a/docs/reference/ml/trained-models/apis/get-trained-models-stats.asciidoc +++ b/docs/reference/ml/trained-models/apis/get-trained-models-stats.asciidoc @@ -6,6 +6,12 @@ Get trained models stats ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-trained-model[{ml-cap} trained model APIs]. +-- + Retrieves usage information for trained models. diff --git a/docs/reference/ml/trained-models/apis/get-trained-models.asciidoc b/docs/reference/ml/trained-models/apis/get-trained-models.asciidoc index f203578c6f1c7..3736766b6b063 100644 --- a/docs/reference/ml/trained-models/apis/get-trained-models.asciidoc +++ b/docs/reference/ml/trained-models/apis/get-trained-models.asciidoc @@ -6,8 +6,13 @@ Get trained models ++++ -Retrieves configuration information for a trained model. +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-trained-model[{ml-cap} trained model APIs]. +-- +Retrieves configuration information for a trained model. [[ml-get-trained-models-request]] == {api-request-title} diff --git a/docs/reference/ml/trained-models/apis/infer-trained-model-deployment.asciidoc b/docs/reference/ml/trained-models/apis/infer-trained-model-deployment.asciidoc index 83bc56d18df63..8bb48eeb5cbf2 100644 --- a/docs/reference/ml/trained-models/apis/infer-trained-model-deployment.asciidoc +++ b/docs/reference/ml/trained-models/apis/infer-trained-model-deployment.asciidoc @@ -6,6 +6,12 @@ Infer trained model deployment ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-trained-model[{ml-cap} trained model APIs]. +-- + Evaluates a trained model. deprecated::[8.3.0,Replaced by <>.] diff --git a/docs/reference/ml/trained-models/apis/infer-trained-model.asciidoc b/docs/reference/ml/trained-models/apis/infer-trained-model.asciidoc index 7acbc0bd23859..93b8aa3422abc 100644 --- a/docs/reference/ml/trained-models/apis/infer-trained-model.asciidoc +++ b/docs/reference/ml/trained-models/apis/infer-trained-model.asciidoc @@ -6,6 +6,12 @@ Infer trained model ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-trained-model[{ml-cap} trained model APIs]. +-- + Evaluates a trained model. The model may be any supervised model either trained by {dfanalytics} or imported. diff --git a/docs/reference/ml/trained-models/apis/ml-trained-models-apis.asciidoc b/docs/reference/ml/trained-models/apis/ml-trained-models-apis.asciidoc index 83ef3c49fb5ed..5b0fc2b83afa5 100644 --- a/docs/reference/ml/trained-models/apis/ml-trained-models-apis.asciidoc +++ b/docs/reference/ml/trained-models/apis/ml-trained-models-apis.asciidoc @@ -2,6 +2,12 @@ [[ml-df-trained-models-apis]] = {ml-cap} trained model APIs +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-trained-model[{ml-cap} trained model APIs]. +-- + You can use the following APIs to perform model management operations: * <> diff --git a/docs/reference/ml/trained-models/apis/put-trained-model-definition-part.asciidoc b/docs/reference/ml/trained-models/apis/put-trained-model-definition-part.asciidoc index d1da29abffcd3..857b86892a6b9 100644 --- a/docs/reference/ml/trained-models/apis/put-trained-model-definition-part.asciidoc +++ b/docs/reference/ml/trained-models/apis/put-trained-model-definition-part.asciidoc @@ -6,6 +6,12 @@ Create part of a trained model ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-trained-model[{ml-cap} trained model APIs]. +-- + Creates part of a trained model definition. [[ml-put-trained-model-definition-part-request]] diff --git a/docs/reference/ml/trained-models/apis/put-trained-model-vocabulary.asciidoc b/docs/reference/ml/trained-models/apis/put-trained-model-vocabulary.asciidoc index 2fdf86259388f..39f93f882235a 100644 --- a/docs/reference/ml/trained-models/apis/put-trained-model-vocabulary.asciidoc +++ b/docs/reference/ml/trained-models/apis/put-trained-model-vocabulary.asciidoc @@ -6,6 +6,12 @@ Create trained model vocabulary ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-trained-model[{ml-cap} trained model APIs]. +-- + Creates a trained model vocabulary. This is supported only for natural language processing (NLP) models. diff --git a/docs/reference/ml/trained-models/apis/put-trained-models-aliases.asciidoc b/docs/reference/ml/trained-models/apis/put-trained-models-aliases.asciidoc index d8c00efe28015..3fcc7f5bb2da4 100644 --- a/docs/reference/ml/trained-models/apis/put-trained-models-aliases.asciidoc +++ b/docs/reference/ml/trained-models/apis/put-trained-models-aliases.asciidoc @@ -6,6 +6,11 @@ Create or update trained model aliases ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-trained-model[{ml-cap} trained model APIs]. +-- Creates or updates a trained model alias. diff --git a/docs/reference/ml/trained-models/apis/put-trained-models.asciidoc b/docs/reference/ml/trained-models/apis/put-trained-models.asciidoc index 32265af5f795b..256c0d29f8d2f 100644 --- a/docs/reference/ml/trained-models/apis/put-trained-models.asciidoc +++ b/docs/reference/ml/trained-models/apis/put-trained-models.asciidoc @@ -3,11 +3,15 @@ = Create trained models API [subs="attributes"] ++++ - Create trained models - ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-trained-model[{ml-cap} trained model APIs]. +-- + Creates a trained model. WARNING: Models created in version 7.8.0 are not backwards compatible diff --git a/docs/reference/ml/trained-models/apis/start-trained-model-deployment.asciidoc b/docs/reference/ml/trained-models/apis/start-trained-model-deployment.asciidoc index bf9c4d14db290..7eaa149976652 100644 --- a/docs/reference/ml/trained-models/apis/start-trained-model-deployment.asciidoc +++ b/docs/reference/ml/trained-models/apis/start-trained-model-deployment.asciidoc @@ -6,6 +6,12 @@ Start trained model deployment ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-trained-model[{ml-cap} trained model APIs]. +-- + Starts a new trained model deployment. [[start-trained-model-deployment-request]] diff --git a/docs/reference/ml/trained-models/apis/stop-trained-model-deployment.asciidoc b/docs/reference/ml/trained-models/apis/stop-trained-model-deployment.asciidoc index 622b440622cd3..2f179e2391b78 100644 --- a/docs/reference/ml/trained-models/apis/stop-trained-model-deployment.asciidoc +++ b/docs/reference/ml/trained-models/apis/stop-trained-model-deployment.asciidoc @@ -6,6 +6,12 @@ Stop trained model deployment ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-trained-model[{ml-cap} trained model APIs]. +-- + Stops a trained model deployment. [[stop-trained-model-deployment-request]] diff --git a/docs/reference/ml/trained-models/apis/update-trained-model-deployment.asciidoc b/docs/reference/ml/trained-models/apis/update-trained-model-deployment.asciidoc index d49ee3c6e872c..a986e412f1a8a 100644 --- a/docs/reference/ml/trained-models/apis/update-trained-model-deployment.asciidoc +++ b/docs/reference/ml/trained-models/apis/update-trained-model-deployment.asciidoc @@ -7,6 +7,12 @@ Update trained model deployment ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ml-trained-model[{ml-cap} trained model APIs]. +-- + Updates certain properties of a trained model deployment. [[update-trained-model-deployment-request]] diff --git a/docs/reference/query-rules/apis/delete-query-rule.asciidoc b/docs/reference/query-rules/apis/delete-query-rule.asciidoc index 01b73033aa361..4d91092eaf8af 100644 --- a/docs/reference/query-rules/apis/delete-query-rule.asciidoc +++ b/docs/reference/query-rules/apis/delete-query-rule.asciidoc @@ -6,6 +6,12 @@ Delete query rule ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-query_rules[Query rules APIs]. +-- + Removes an individual query rule within an existing query ruleset. This is a destructive action that is only recoverable by re-adding the same rule via the <> API. diff --git a/docs/reference/query-rules/apis/delete-query-ruleset.asciidoc b/docs/reference/query-rules/apis/delete-query-ruleset.asciidoc index 31507dce3d12d..168310dcd4078 100644 --- a/docs/reference/query-rules/apis/delete-query-ruleset.asciidoc +++ b/docs/reference/query-rules/apis/delete-query-ruleset.asciidoc @@ -6,6 +6,12 @@ Delete query ruleset ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-query_rules[Query rules APIs]. +-- + Removes a query ruleset and its associated data. This is a destructive action that is not recoverable. diff --git a/docs/reference/query-rules/apis/get-query-rule.asciidoc b/docs/reference/query-rules/apis/get-query-rule.asciidoc index 56713965d7bdc..742982e5897e1 100644 --- a/docs/reference/query-rules/apis/get-query-rule.asciidoc +++ b/docs/reference/query-rules/apis/get-query-rule.asciidoc @@ -6,6 +6,12 @@ Get query rule ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-query_rules[Query rules APIs]. +-- + Retrieves information about an individual query rule within a query ruleset. [[get-query-rule-request]] diff --git a/docs/reference/query-rules/apis/get-query-ruleset.asciidoc b/docs/reference/query-rules/apis/get-query-ruleset.asciidoc index 6bbcd157ea9e1..55574fb7c67e9 100644 --- a/docs/reference/query-rules/apis/get-query-ruleset.asciidoc +++ b/docs/reference/query-rules/apis/get-query-ruleset.asciidoc @@ -6,6 +6,12 @@ Get query ruleset ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-query_rules[Query rules APIs]. +-- + Retrieves information about a query ruleset. [[get-query-ruleset-request]] diff --git a/docs/reference/query-rules/apis/index.asciidoc b/docs/reference/query-rules/apis/index.asciidoc index fbeb477acacb5..7dcdf0e8f4e1c 100644 --- a/docs/reference/query-rules/apis/index.asciidoc +++ b/docs/reference/query-rules/apis/index.asciidoc @@ -7,6 +7,12 @@ --- +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-query_rules[Query rules APIs]. +-- + <> allow you to configure per-query rules that are applied at query time to queries that match the specific rule. Query rules are organized into _rulesets_, collections of query rules that are matched against incoming queries. Query rules are applied using the <>. diff --git a/docs/reference/query-rules/apis/list-query-rulesets.asciidoc b/docs/reference/query-rules/apis/list-query-rulesets.asciidoc index 304b8c7745007..5f61bcb98b085 100644 --- a/docs/reference/query-rules/apis/list-query-rulesets.asciidoc +++ b/docs/reference/query-rules/apis/list-query-rulesets.asciidoc @@ -6,6 +6,12 @@ List query rulesets ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-query_rules[Query rules APIs]. +-- + Returns information about all stored query rulesets. Summary information on the number of rules per ruleset will be returned, and full details can be returned with the <> command. diff --git a/docs/reference/query-rules/apis/put-query-rule.asciidoc b/docs/reference/query-rules/apis/put-query-rule.asciidoc index 714ed9b096d1d..df33d22b39029 100644 --- a/docs/reference/query-rules/apis/put-query-rule.asciidoc +++ b/docs/reference/query-rules/apis/put-query-rule.asciidoc @@ -6,6 +6,12 @@ Create or update query rule ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-query_rules[Query rules APIs]. +-- + Creates or updates an individual query rule within a query ruleset. [[put-query-rule-request]] diff --git a/docs/reference/query-rules/apis/put-query-ruleset.asciidoc b/docs/reference/query-rules/apis/put-query-ruleset.asciidoc index df7ec100db076..ea689dc0bf305 100644 --- a/docs/reference/query-rules/apis/put-query-ruleset.asciidoc +++ b/docs/reference/query-rules/apis/put-query-ruleset.asciidoc @@ -6,6 +6,12 @@ Create or update query ruleset ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-query_rules[Query rules APIs]. +-- + Creates or updates a query ruleset. [[put-query-ruleset-request]] diff --git a/docs/reference/query-rules/apis/test-query-ruleset.asciidoc b/docs/reference/query-rules/apis/test-query-ruleset.asciidoc index 4a670645cea6e..4a47754f572e5 100644 --- a/docs/reference/query-rules/apis/test-query-ruleset.asciidoc +++ b/docs/reference/query-rules/apis/test-query-ruleset.asciidoc @@ -6,6 +6,12 @@ Tests query ruleset ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-query_rules[Query rules APIs]. +-- + Evaluates match criteria against a query ruleset to identify the rules that would match that criteria. preview::[] diff --git a/docs/reference/repositories-metering-api/apis/clear-repositories-metering-archive.asciidoc b/docs/reference/repositories-metering-api/apis/clear-repositories-metering-archive.asciidoc index addcd65f0e84a..bd05d76705eb9 100644 --- a/docs/reference/repositories-metering-api/apis/clear-repositories-metering-archive.asciidoc +++ b/docs/reference/repositories-metering-api/apis/clear-repositories-metering-archive.asciidoc @@ -5,6 +5,12 @@ Clear repositories metering archive ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/operation/operation-nodes-clear-repositories-metering-archive[Clear the archived repositories metering API]. +-- + Removes the archived repositories metering information present in the cluster. [[clear-repositories-metering-archive-api-request]] diff --git a/docs/reference/repositories-metering-api/apis/get-repositories-metering.asciidoc b/docs/reference/repositories-metering-api/apis/get-repositories-metering.asciidoc index 314f85a7dba52..6b6d98a69ded2 100644 --- a/docs/reference/repositories-metering-api/apis/get-repositories-metering.asciidoc +++ b/docs/reference/repositories-metering-api/apis/get-repositories-metering.asciidoc @@ -5,6 +5,12 @@ Get repositories metering information ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/operation/operation-nodes-get-repositories-metering-info[Get cluster repositories metering API]. +-- + Returns cluster repositories metering information. [[get-repositories-metering-api-request]] diff --git a/docs/reference/repositories-metering-api/repositories-metering-apis.asciidoc b/docs/reference/repositories-metering-api/repositories-metering-apis.asciidoc index b838e0fb213f4..ca9bffa32a917 100644 --- a/docs/reference/repositories-metering-api/repositories-metering-apis.asciidoc +++ b/docs/reference/repositories-metering-api/repositories-metering-apis.asciidoc @@ -4,6 +4,12 @@ experimental[] +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. +-- + You can use the following APIs to retrieve repositories metering information. This is an API used by Elastic's commercial offerings. diff --git a/docs/reference/rest-api/index.asciidoc b/docs/reference/rest-api/index.asciidoc index bfab15ed012c4..9d9047c93cc97 100644 --- a/docs/reference/rest-api/index.asciidoc +++ b/docs/reference/rest-api/index.asciidoc @@ -6,7 +6,7 @@ {es} exposes REST APIs that are used by the UI components and can be called directly to configure and access {es} features. -..New API reference +.New API reference [sidebar] For the most up-to-date API details, refer to {api-es}[{es} APIs]. diff --git a/docs/reference/rest-api/info.asciidoc b/docs/reference/rest-api/info.asciidoc index fda5b07d28205..b9547163b07ba 100644 --- a/docs/reference/rest-api/info.asciidoc +++ b/docs/reference/rest-api/info.asciidoc @@ -2,6 +2,12 @@ [[info-api]] == Info API +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-info[Info APIs]. +-- + Provides general information about the installed {xpack} features. [discrete] diff --git a/docs/reference/rest-api/logstash/delete-pipeline.asciidoc b/docs/reference/rest-api/logstash/delete-pipeline.asciidoc index ff7494d34e615..2e56b0289a394 100644 --- a/docs/reference/rest-api/logstash/delete-pipeline.asciidoc +++ b/docs/reference/rest-api/logstash/delete-pipeline.asciidoc @@ -5,6 +5,12 @@ Delete {ls} pipeline ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-logstash[{ls} APIs]. +-- + This API deletes a pipeline used for {logstash-ref}/logstash-centralized-pipeline-management.html[{ls} Central Management]. diff --git a/docs/reference/rest-api/logstash/get-pipeline.asciidoc b/docs/reference/rest-api/logstash/get-pipeline.asciidoc index 8409a5128d525..8e440f218aa09 100644 --- a/docs/reference/rest-api/logstash/get-pipeline.asciidoc +++ b/docs/reference/rest-api/logstash/get-pipeline.asciidoc @@ -5,6 +5,12 @@ Get {ls} pipeline ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-logstash[{ls} APIs]. +-- + This API retrieves pipelines used for {logstash-ref}/logstash-centralized-pipeline-management.html[{ls} Central Management]. diff --git a/docs/reference/rest-api/logstash/index.asciidoc b/docs/reference/rest-api/logstash/index.asciidoc index a52be19a75df4..7f28020a8b183 100644 --- a/docs/reference/rest-api/logstash/index.asciidoc +++ b/docs/reference/rest-api/logstash/index.asciidoc @@ -2,6 +2,12 @@ [[logstash-apis]] == {ls} APIs +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-logstash[{ls} APIs]. +-- + The following APIs are used to manage pipelines used by {logstash-ref}/logstash-centralized-pipeline-management.html[{ls} Central Management]: diff --git a/docs/reference/rest-api/logstash/put-pipeline.asciidoc b/docs/reference/rest-api/logstash/put-pipeline.asciidoc index a0d2f02f2bf6f..26af8d0f124cb 100644 --- a/docs/reference/rest-api/logstash/put-pipeline.asciidoc +++ b/docs/reference/rest-api/logstash/put-pipeline.asciidoc @@ -5,6 +5,12 @@ Create or update {ls} pipeline ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-logstash[{ls} APIs]. +-- + This API creates or updates a {ls} pipeline used for {logstash-ref}/logstash-centralized-pipeline-management.html[{ls} Central Management]. diff --git a/docs/reference/rest-api/root.asciidoc b/docs/reference/rest-api/root.asciidoc index 8821981c2afe3..aaf40b31db21c 100644 --- a/docs/reference/rest-api/root.asciidoc +++ b/docs/reference/rest-api/root.asciidoc @@ -4,6 +4,12 @@ Root API ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-info[Info APIs]. +-- + The Elasticsearch API's base url returns its basic build, version, and cluster information. diff --git a/docs/reference/rollup/apis/delete-job.asciidoc b/docs/reference/rollup/apis/delete-job.asciidoc index c563e705039e2..03f5349e15d4f 100644 --- a/docs/reference/rollup/apis/delete-job.asciidoc +++ b/docs/reference/rollup/apis/delete-job.asciidoc @@ -8,6 +8,12 @@ deprecated::[8.11.0,"Rollups will be removed in a future version. Use <> instead."] +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-rollup[Rollup APIs]. +-- + Deletes an existing {rollup-job}. [[rollup-delete-job-request]] diff --git a/docs/reference/rollup/apis/get-job.asciidoc b/docs/reference/rollup/apis/get-job.asciidoc index fcafbbe95159b..9fff4d665f5fd 100644 --- a/docs/reference/rollup/apis/get-job.asciidoc +++ b/docs/reference/rollup/apis/get-job.asciidoc @@ -7,6 +7,12 @@ deprecated::[8.11.0,"Rollups will be removed in a future version. Use <> instead."] +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-rollup[Rollup APIs]. +-- + Retrieves the configuration, stats, and status of {rollup-jobs}. [[rollup-get-job-request]] diff --git a/docs/reference/rollup/apis/put-job.asciidoc b/docs/reference/rollup/apis/put-job.asciidoc index c52e7a042e0ca..a60f20a3de5bf 100644 --- a/docs/reference/rollup/apis/put-job.asciidoc +++ b/docs/reference/rollup/apis/put-job.asciidoc @@ -12,6 +12,12 @@ WARNING: From 8.15.0 invoking this API in a cluster with no rollup usage will fa deprecation and planned removal. A cluster either needs to contain a rollup job or a rollup index in order for this API to be allowed to execute. +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-rollup[Rollup APIs]. +-- + Creates a {rollup-job}. [[rollup-put-job-api-request]] diff --git a/docs/reference/rollup/apis/rollup-caps.asciidoc b/docs/reference/rollup/apis/rollup-caps.asciidoc index 95f652f6d4415..be1c3ed171a23 100644 --- a/docs/reference/rollup/apis/rollup-caps.asciidoc +++ b/docs/reference/rollup/apis/rollup-caps.asciidoc @@ -7,6 +7,12 @@ deprecated::[8.11.0,"Rollups will be removed in a future version. Use <> instead."] +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-rollup[Rollup APIs]. +-- + Returns the capabilities of any {rollup-jobs} that have been configured for a specific index or index pattern. diff --git a/docs/reference/rollup/apis/rollup-index-caps.asciidoc b/docs/reference/rollup/apis/rollup-index-caps.asciidoc index c5b729f2e52e6..830cc332e8f40 100644 --- a/docs/reference/rollup/apis/rollup-index-caps.asciidoc +++ b/docs/reference/rollup/apis/rollup-index-caps.asciidoc @@ -7,6 +7,12 @@ deprecated::[8.11.0,"Rollups will be removed in a future version. Use <> instead."] +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-rollup[Rollup APIs]. +-- + Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the index where rollup data is stored). diff --git a/docs/reference/rollup/apis/rollup-search.asciidoc b/docs/reference/rollup/apis/rollup-search.asciidoc index 491dcc6c38ae2..088a74973806b 100644 --- a/docs/reference/rollup/apis/rollup-search.asciidoc +++ b/docs/reference/rollup/apis/rollup-search.asciidoc @@ -7,6 +7,12 @@ deprecated::[8.11.0,"Rollups will be removed in a future version. Use <> instead."] +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-rollup[Rollup APIs]. +-- + Enables searching rolled-up data using the standard Query DSL. [[rollup-search-request]] diff --git a/docs/reference/rollup/apis/start-job.asciidoc b/docs/reference/rollup/apis/start-job.asciidoc index c102c26ea5d8e..dbeed8b09d1c8 100644 --- a/docs/reference/rollup/apis/start-job.asciidoc +++ b/docs/reference/rollup/apis/start-job.asciidoc @@ -8,6 +8,12 @@ deprecated::[8.11.0,"Rollups will be removed in a future version. Use <> instead."] +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-rollup[Rollup APIs]. +-- + Starts an existing, stopped {rollup-job}. [[rollup-start-job-request]] diff --git a/docs/reference/rollup/apis/stop-job.asciidoc b/docs/reference/rollup/apis/stop-job.asciidoc index 61e561b4ceac9..8c0fd6ab2f3af 100644 --- a/docs/reference/rollup/apis/stop-job.asciidoc +++ b/docs/reference/rollup/apis/stop-job.asciidoc @@ -8,6 +8,12 @@ deprecated::[8.11.0,"Rollups will be removed in a future version. Use <> instead."] +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-rollup[Rollup APIs]. +-- + Stops an existing, started {rollup-job}. [[rollup-stop-job-request]] diff --git a/docs/reference/rollup/rollup-apis.asciidoc b/docs/reference/rollup/rollup-apis.asciidoc index 44833a0846c2f..71922f0932a0e 100644 --- a/docs/reference/rollup/rollup-apis.asciidoc +++ b/docs/reference/rollup/rollup-apis.asciidoc @@ -4,6 +4,12 @@ deprecated::[8.11.0,"Rollups will be removed in a future version. Please <> to <> instead."] +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-rollup[Rollup APIs]. +-- + [discrete] [[rollup-jobs-endpoint]] === Jobs diff --git a/docs/reference/scripting/apis/create-stored-script-api.asciidoc b/docs/reference/scripting/apis/create-stored-script-api.asciidoc index dab1314e65dc4..5636e212180b3 100644 --- a/docs/reference/scripting/apis/create-stored-script-api.asciidoc +++ b/docs/reference/scripting/apis/create-stored-script-api.asciidoc @@ -4,6 +4,12 @@ Create or update stored script ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-script[Script APIs]. +-- + Creates or updates a <> or <>. diff --git a/docs/reference/scripting/apis/delete-stored-script-api.asciidoc b/docs/reference/scripting/apis/delete-stored-script-api.asciidoc index e233922c9a7d5..c6e570f2013e4 100644 --- a/docs/reference/scripting/apis/delete-stored-script-api.asciidoc +++ b/docs/reference/scripting/apis/delete-stored-script-api.asciidoc @@ -4,6 +4,12 @@ Delete stored script ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-script[Script APIs]. +-- + Deletes a <> or <>. diff --git a/docs/reference/scripting/apis/get-script-contexts-api.asciidoc b/docs/reference/scripting/apis/get-script-contexts-api.asciidoc index ca24c97e494ee..0ef6eccf947ad 100644 --- a/docs/reference/scripting/apis/get-script-contexts-api.asciidoc +++ b/docs/reference/scripting/apis/get-script-contexts-api.asciidoc @@ -4,6 +4,12 @@ Get script contexts ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-script[Script APIs]. +-- + Retrieves a list of supported script contexts and their methods. [source,console] diff --git a/docs/reference/scripting/apis/get-script-languages-api.asciidoc b/docs/reference/scripting/apis/get-script-languages-api.asciidoc index dd5935bc4dcd8..a35c979b2fccb 100644 --- a/docs/reference/scripting/apis/get-script-languages-api.asciidoc +++ b/docs/reference/scripting/apis/get-script-languages-api.asciidoc @@ -4,6 +4,12 @@ Get script languages ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-script[Script APIs]. +-- + Retrieves a list of supported <> and their contexts. diff --git a/docs/reference/scripting/apis/get-stored-script-api.asciidoc b/docs/reference/scripting/apis/get-stored-script-api.asciidoc index fffeb24e0331f..d2e5a7beedad1 100644 --- a/docs/reference/scripting/apis/get-stored-script-api.asciidoc +++ b/docs/reference/scripting/apis/get-stored-script-api.asciidoc @@ -4,6 +4,12 @@ Get stored script ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-script[Script APIs]. +-- + Retrieves a <> or <>. diff --git a/docs/reference/scripting/apis/script-apis.asciidoc b/docs/reference/scripting/apis/script-apis.asciidoc index e344cb00ee6fe..f5499ade8458a 100644 --- a/docs/reference/scripting/apis/script-apis.asciidoc +++ b/docs/reference/scripting/apis/script-apis.asciidoc @@ -1,6 +1,12 @@ [[script-apis]] == Script APIs +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-script[Script APIs]. +-- + Use the following APIs to manage, store, and test your <>. diff --git a/docs/reference/search-application/apis/delete-search-application.asciidoc b/docs/reference/search-application/apis/delete-search-application.asciidoc index 4043942b09503..52a32247a79e1 100644 --- a/docs/reference/search-application/apis/delete-search-application.asciidoc +++ b/docs/reference/search-application/apis/delete-search-application.asciidoc @@ -1,13 +1,18 @@ [role="xpack"] [[delete-search-application]] === Delete Search Application - -beta::[] - ++++ Delete Search Application ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search_application[Search application APIs]. +-- + +beta::[] + Removes a Search Application and its associated alias. Indices attached to the Search Application are not removed. diff --git a/docs/reference/search-application/apis/get-search-application.asciidoc b/docs/reference/search-application/apis/get-search-application.asciidoc index f0c107011eb40..adeb84bdbe0ae 100644 --- a/docs/reference/search-application/apis/get-search-application.asciidoc +++ b/docs/reference/search-application/apis/get-search-application.asciidoc @@ -1,13 +1,18 @@ [role="xpack"] [[get-search-application]] === Get Search Application - -beta::[] - ++++ Get Search Application ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search_application[Search application APIs]. +-- + +beta::[] + Retrieves information about a search application. [[get-search-application-request]] diff --git a/docs/reference/search-application/apis/index.asciidoc b/docs/reference/search-application/apis/index.asciidoc index 1df38f6a841cc..a01b93a1ee4ac 100644 --- a/docs/reference/search-application/apis/index.asciidoc +++ b/docs/reference/search-application/apis/index.asciidoc @@ -9,6 +9,12 @@ beta::[] --- +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search_application[Search application APIs]. +-- + Use Search Application APIs to manage tasks and resources related to Search Applications. * <> diff --git a/docs/reference/search-application/apis/list-search-applications.asciidoc b/docs/reference/search-application/apis/list-search-applications.asciidoc index 3cc077bf682d6..33bd8ddee009e 100644 --- a/docs/reference/search-application/apis/list-search-applications.asciidoc +++ b/docs/reference/search-application/apis/list-search-applications.asciidoc @@ -1,13 +1,18 @@ [role="xpack"] [[list-search-applications]] === List Search Applications - -beta::[] - ++++ List Search Applications ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search_application[Search application APIs]. +-- + +beta::[] + Returns information about Search Applications. [[list-search-applications-request]] diff --git a/docs/reference/search-application/apis/put-search-application.asciidoc b/docs/reference/search-application/apis/put-search-application.asciidoc index eb559acc8cdc7..3dffb86782227 100644 --- a/docs/reference/search-application/apis/put-search-application.asciidoc +++ b/docs/reference/search-application/apis/put-search-application.asciidoc @@ -1,13 +1,18 @@ [role="xpack"] [[put-search-application]] === Put Search Application - -beta::[] - ++++ Put Search Application ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search_application[Search application APIs]. +-- + +beta::[] + Creates or updates a Search Application. [[put-search-application-request]] diff --git a/docs/reference/search-application/apis/search-application-render-query.asciidoc b/docs/reference/search-application/apis/search-application-render-query.asciidoc index 687176b4fb070..42586c7186bc8 100644 --- a/docs/reference/search-application/apis/search-application-render-query.asciidoc +++ b/docs/reference/search-application/apis/search-application-render-query.asciidoc @@ -1,13 +1,18 @@ [role="xpack"] [[search-application-render-query]] === Render Search Application Query - -preview::[] - ++++ Render Search Application Query ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search_application[Search application APIs]. +-- + +preview::[] + Given specified query parameters, generates an {es} query using the search template associated with the search application or a default template if none is specified. Unspecified template parameters will be assigned their default values (if applicable). diff --git a/docs/reference/search-application/apis/search-application-search.asciidoc b/docs/reference/search-application/apis/search-application-search.asciidoc index 2d13ed5f11037..1aab4ddf84763 100644 --- a/docs/reference/search-application/apis/search-application-search.asciidoc +++ b/docs/reference/search-application/apis/search-application-search.asciidoc @@ -1,13 +1,18 @@ [role="xpack"] [[search-application-search]] === Search Application Search - -beta::[] - ++++ Search Application Search ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search_application[Search application APIs]. +-- + +beta::[] + Given specified query parameters, generates and executes an {es} query using the search template associated with the search application or a default template if none is specified. Unspecified template parameters will be assigned their default values (if applicable). diff --git a/docs/reference/search.asciidoc b/docs/reference/search.asciidoc index b39afff876eed..268fa4d04603d 100644 --- a/docs/reference/search.asciidoc +++ b/docs/reference/search.asciidoc @@ -1,6 +1,12 @@ [[search]] == Search APIs +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search[Search APIs]. +-- + Search APIs are used to search and aggregate data stored in {es} indices and data streams. For an overview and related tutorials, see <>. diff --git a/docs/reference/search/async-search.asciidoc b/docs/reference/search/async-search.asciidoc index 786cfaee8024c..9a9e9ca45e817 100644 --- a/docs/reference/search/async-search.asciidoc +++ b/docs/reference/search/async-search.asciidoc @@ -2,6 +2,12 @@ [[async-search]] === Async search +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search[Search APIs]. +-- + The async search API let you asynchronously execute a search request, monitor its progress, and retrieve partial results as they become available. diff --git a/docs/reference/search/clear-scroll-api.asciidoc b/docs/reference/search/clear-scroll-api.asciidoc index a005babfd1bef..a6a2cd4b3cab5 100644 --- a/docs/reference/search/clear-scroll-api.asciidoc +++ b/docs/reference/search/clear-scroll-api.asciidoc @@ -4,6 +4,12 @@ Clear scroll ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search[Search APIs]. +-- + Clears the search context and results for a <>. diff --git a/docs/reference/search/count.asciidoc b/docs/reference/search/count.asciidoc index 399545adf8d1d..e0e86dd131291 100644 --- a/docs/reference/search/count.asciidoc +++ b/docs/reference/search/count.asciidoc @@ -4,6 +4,12 @@ Count ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search[Search APIs]. +-- + Gets the number of matches for a search query. [source,console] diff --git a/docs/reference/search/explain.asciidoc b/docs/reference/search/explain.asciidoc index 77e2d5bd63efd..01c7bb4611a12 100644 --- a/docs/reference/search/explain.asciidoc +++ b/docs/reference/search/explain.asciidoc @@ -4,6 +4,12 @@ Explain ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search[Search APIs]. +-- + Returns information about why a specific document matches (or doesn't match) a query. diff --git a/docs/reference/search/field-caps.asciidoc b/docs/reference/search/field-caps.asciidoc index 2ff2b8d18604e..f4d9146b8ea9d 100644 --- a/docs/reference/search/field-caps.asciidoc +++ b/docs/reference/search/field-caps.asciidoc @@ -4,6 +4,11 @@ Field capabilities ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search[Search APIs]. +-- Allows you to retrieve the capabilities of fields among multiple indices. For data streams, the API returns field capabilities among the stream's backing diff --git a/docs/reference/search/multi-search-template-api.asciidoc b/docs/reference/search/multi-search-template-api.asciidoc index b1c9518b1f2bc..010320c6b05ed 100644 --- a/docs/reference/search/multi-search-template-api.asciidoc +++ b/docs/reference/search/multi-search-template-api.asciidoc @@ -4,6 +4,12 @@ Multi search template ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search[Search APIs]. +-- + Runs multiple <> with a single request. diff --git a/docs/reference/search/multi-search.asciidoc b/docs/reference/search/multi-search.asciidoc index 9cafa756f035e..ea2dd59779332 100644 --- a/docs/reference/search/multi-search.asciidoc +++ b/docs/reference/search/multi-search.asciidoc @@ -4,6 +4,12 @@ Multi search ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search[Search APIs]. +-- + Executes several searches with a single API request. [source,console] diff --git a/docs/reference/search/point-in-time-api.asciidoc b/docs/reference/search/point-in-time-api.asciidoc index 9cd91626c7600..bc7cbd01ebb36 100644 --- a/docs/reference/search/point-in-time-api.asciidoc +++ b/docs/reference/search/point-in-time-api.asciidoc @@ -4,6 +4,12 @@ Point in time ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search[Search APIs]. +-- + A search request by default executes against the most recent visible data of the target indices, which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the state of the data as it existed when initiated. diff --git a/docs/reference/search/profile.asciidoc b/docs/reference/search/profile.asciidoc index 3fed14231808c..f69092847c232 100644 --- a/docs/reference/search/profile.asciidoc +++ b/docs/reference/search/profile.asciidoc @@ -24,6 +24,11 @@ The output from the Profile API is *very* verbose, especially for complicated requests executed across many shards. Pretty-printing the response is recommended to help understand the output. +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search[Search APIs]. +-- [[search-profile-api-example]] ==== {api-examples-title} diff --git a/docs/reference/search/rank-eval.asciidoc b/docs/reference/search/rank-eval.asciidoc index 05862ebbbcca5..4a03371c4da3d 100644 --- a/docs/reference/search/rank-eval.asciidoc +++ b/docs/reference/search/rank-eval.asciidoc @@ -4,6 +4,12 @@ Ranking evaluation ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search[Search APIs]. +-- + Allows you to evaluate the quality of ranked search results over a set of typical search queries. diff --git a/docs/reference/search/render-search-template-api.asciidoc b/docs/reference/search/render-search-template-api.asciidoc index 0c782f26068e6..42e82b6e352be 100644 --- a/docs/reference/search/render-search-template-api.asciidoc +++ b/docs/reference/search/render-search-template-api.asciidoc @@ -4,6 +4,12 @@ Render search template ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search[Search APIs]. +-- + Renders a <> as a <>. diff --git a/docs/reference/search/retriever.asciidoc b/docs/reference/search/retriever.asciidoc index cb04d4fb6fbf1..ae9c9b770d814 100644 --- a/docs/reference/search/retriever.asciidoc +++ b/docs/reference/search/retriever.asciidoc @@ -14,6 +14,12 @@ Refer to <> for a high level overview of the retrievers abs Refer to <> for additional examples. ==== +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search[Search APIs]. +-- + The following retrievers are available: `standard`:: diff --git a/docs/reference/search/rrf.asciidoc b/docs/reference/search/rrf.asciidoc index a942c0162a80a..842bd7049e3bf 100644 --- a/docs/reference/search/rrf.asciidoc +++ b/docs/reference/search/rrf.asciidoc @@ -27,6 +27,12 @@ return score [[rrf-api]] ==== Reciprocal rank fusion API +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search[Search APIs]. +-- + You can use RRF as part of a <> to combine and rank documents using separate sets of top documents (result sets) from a combination of <> using an <>. A minimum of *two* child retrievers is required for ranking. diff --git a/docs/reference/search/scroll-api.asciidoc b/docs/reference/search/scroll-api.asciidoc index e3b4123ddff68..0f89df877ba74 100644 --- a/docs/reference/search/scroll-api.asciidoc +++ b/docs/reference/search/scroll-api.asciidoc @@ -8,6 +8,12 @@ IMPORTANT: We no longer recommend using the scroll API for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the <> parameter with a point in time (PIT). +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search[Search APIs]. +-- + Retrieves the next batch of results for a <>. diff --git a/docs/reference/search/search-shards.asciidoc b/docs/reference/search/search-shards.asciidoc index 49045acf4c484..13f9ae8772858 100644 --- a/docs/reference/search/search-shards.asciidoc +++ b/docs/reference/search/search-shards.asciidoc @@ -4,6 +4,12 @@ Search shards ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search[Search APIs]. +-- + Returns the indices and shards that a search request would be executed against. [source,console] diff --git a/docs/reference/search/search-template-api.asciidoc b/docs/reference/search/search-template-api.asciidoc index c60b5281c05e5..2094ee8924014 100644 --- a/docs/reference/search/search-template-api.asciidoc +++ b/docs/reference/search/search-template-api.asciidoc @@ -4,6 +4,12 @@ Search template ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search[Search APIs]. +-- + Runs a search with a <>. //// diff --git a/docs/reference/search/search-vector-tile-api.asciidoc b/docs/reference/search/search-vector-tile-api.asciidoc index 2cdc29918a699..f63abda6fcb47 100644 --- a/docs/reference/search/search-vector-tile-api.asciidoc +++ b/docs/reference/search/search-vector-tile-api.asciidoc @@ -4,6 +4,11 @@ Vector tile search ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search[Search APIs]. +-- Searches a vector tile for geospatial values. Returns results as a binary https://docs.mapbox.com/vector-tiles/specification[Mapbox vector tile]. diff --git a/docs/reference/search/search.asciidoc b/docs/reference/search/search.asciidoc index 2ad407b4ae1e4..d022605db22b1 100644 --- a/docs/reference/search/search.asciidoc +++ b/docs/reference/search/search.asciidoc @@ -4,6 +4,12 @@ Search ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search[Search APIs]. +-- + Returns search hits that match the query defined in the request. [source,console] diff --git a/docs/reference/search/suggesters.asciidoc b/docs/reference/search/suggesters.asciidoc index c5cdbc3bd6660..22f427477b905 100644 --- a/docs/reference/search/suggesters.asciidoc +++ b/docs/reference/search/suggesters.asciidoc @@ -3,6 +3,12 @@ Suggests similar looking terms based on a provided text by using a suggester. +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search[Search APIs]. +-- + [source,console] -------------------------------------------------- POST my-index-000001/_search diff --git a/docs/reference/search/terms-enum.asciidoc b/docs/reference/search/terms-enum.asciidoc index 4f34deb985abe..46f6d3560ecdb 100644 --- a/docs/reference/search/terms-enum.asciidoc +++ b/docs/reference/search/terms-enum.asciidoc @@ -4,6 +4,12 @@ Terms enum ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-search[Search APIs]. +-- + The terms enum API can be used to discover terms in the index that match a partial string. Supported field types are <>, <>, <>, diff --git a/docs/reference/search/validate.asciidoc b/docs/reference/search/validate.asciidoc index ce682e485cd27..ab943cf72b463 100644 --- a/docs/reference/search/validate.asciidoc +++ b/docs/reference/search/validate.asciidoc @@ -4,6 +4,12 @@ Validate ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/operation/operation-indices-validate-query[Validate a query]. +-- + Validates a potentially expensive query without executing it. [source,console] diff --git a/docs/reference/shutdown/apis/shutdown-api.asciidoc b/docs/reference/shutdown/apis/shutdown-api.asciidoc index 24cbca720d160..b950cd3d19c56 100644 --- a/docs/reference/shutdown/apis/shutdown-api.asciidoc +++ b/docs/reference/shutdown/apis/shutdown-api.asciidoc @@ -4,6 +4,12 @@ NOTE: {cloud-only} +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-shutdown[Node lifecycle APIs]. +-- + You use the shutdown APIs to prepare nodes for temporary or permanent shutdown, monitor the shutdown status, and enable a previously shut-down node to resume normal operations. [discrete] diff --git a/docs/reference/shutdown/apis/shutdown-delete.asciidoc b/docs/reference/shutdown/apis/shutdown-delete.asciidoc index 4d7f30c3a1e48..225d88c63a016 100644 --- a/docs/reference/shutdown/apis/shutdown-delete.asciidoc +++ b/docs/reference/shutdown/apis/shutdown-delete.asciidoc @@ -3,6 +3,12 @@ NOTE: {cloud-only} +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-shutdown[Node lifecycle APIs]. +-- + Cancels shutdown preparations or clears a shutdown request so a node can resume normal operations. diff --git a/docs/reference/shutdown/apis/shutdown-get.asciidoc b/docs/reference/shutdown/apis/shutdown-get.asciidoc index 5feac28353ab5..b022cf2d13d55 100644 --- a/docs/reference/shutdown/apis/shutdown-get.asciidoc +++ b/docs/reference/shutdown/apis/shutdown-get.asciidoc @@ -3,6 +3,12 @@ NOTE: {cloud-only} +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-shutdown[Node lifecycle APIs]. +-- + Retrieves the status of a node that's being prepared for shutdown. [[get-shutdown-api-request]] diff --git a/docs/reference/shutdown/apis/shutdown-put.asciidoc b/docs/reference/shutdown/apis/shutdown-put.asciidoc index 344dd8fa36717..5eef4763a9c3a 100644 --- a/docs/reference/shutdown/apis/shutdown-put.asciidoc +++ b/docs/reference/shutdown/apis/shutdown-put.asciidoc @@ -3,6 +3,12 @@ NOTE: {cloud-only} +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-shutdown[Node lifecycle APIs]. +-- + Prepares a node to be shut down. [[put-shutdown-api-request]]