diff --git a/docs/reference/autoscaling/apis/autoscaling-apis.asciidoc b/docs/reference/autoscaling/apis/autoscaling-apis.asciidoc index e4da2c45ee97..87de3818bfaf 100644 --- a/docs/reference/autoscaling/apis/autoscaling-apis.asciidoc +++ b/docs/reference/autoscaling/apis/autoscaling-apis.asciidoc @@ -4,6 +4,13 @@ NOTE: {cloud-only} + +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[Autoscaling APIs]. +-- + You can use the following APIs to perform {cloud}/ec-autoscaling.html[autoscaling operations]. [discrete] diff --git a/docs/reference/autoscaling/apis/delete-autoscaling-policy.asciidoc b/docs/reference/autoscaling/apis/delete-autoscaling-policy.asciidoc index 190428485a00..349e40aab054 100644 --- a/docs/reference/autoscaling/apis/delete-autoscaling-policy.asciidoc +++ b/docs/reference/autoscaling/apis/delete-autoscaling-policy.asciidoc @@ -7,6 +7,12 @@ NOTE: {cloud-only} +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[Autoscaling APIs]. +-- + Delete {cloud}/ec-autoscaling.html[autoscaling] policy. [[autoscaling-delete-autoscaling-policy-request]] diff --git a/docs/reference/autoscaling/apis/get-autoscaling-capacity.asciidoc b/docs/reference/autoscaling/apis/get-autoscaling-capacity.asciidoc index d635d8c8f7bd..d45f7cbacc24 100644 --- a/docs/reference/autoscaling/apis/get-autoscaling-capacity.asciidoc +++ b/docs/reference/autoscaling/apis/get-autoscaling-capacity.asciidoc @@ -7,6 +7,12 @@ NOTE: {cloud-only} +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[Autoscaling APIs]. +-- + Get {cloud}/ec-autoscaling.html[autoscaling] capacity. [[autoscaling-get-autoscaling-capacity-request]] diff --git a/docs/reference/autoscaling/apis/get-autoscaling-policy.asciidoc b/docs/reference/autoscaling/apis/get-autoscaling-policy.asciidoc index 973eedcb361c..9962b266fb66 100644 --- a/docs/reference/autoscaling/apis/get-autoscaling-policy.asciidoc +++ b/docs/reference/autoscaling/apis/get-autoscaling-policy.asciidoc @@ -7,6 +7,13 @@ NOTE: {cloud-only} +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[Autoscaling APIs]. +-- + + Get {cloud}/ec-autoscaling.html[autoscaling] policy. [[autoscaling-get-autoscaling-policy-request]] diff --git a/docs/reference/autoscaling/apis/put-autoscaling-policy.asciidoc b/docs/reference/autoscaling/apis/put-autoscaling-policy.asciidoc index e564f83411eb..97c6a54fab03 100644 --- a/docs/reference/autoscaling/apis/put-autoscaling-policy.asciidoc +++ b/docs/reference/autoscaling/apis/put-autoscaling-policy.asciidoc @@ -7,6 +7,12 @@ NOTE: {cloud-only} +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-autoscaling[Autoscaling APIs]. +-- + Creates or updates an {cloud}/ec-autoscaling.html[autoscaling] policy. [[autoscaling-put-autoscaling-policy-request]] diff --git a/docs/reference/behavioral-analytics/apis/delete-analytics-collection.asciidoc b/docs/reference/behavioral-analytics/apis/delete-analytics-collection.asciidoc index a6894a933b46..19c1b5437ef0 100644 --- a/docs/reference/behavioral-analytics/apis/delete-analytics-collection.asciidoc +++ b/docs/reference/behavioral-analytics/apis/delete-analytics-collection.asciidoc @@ -8,6 +8,12 @@ beta::[] Delete Analytics Collection ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-analytics[Behavioral analytics APIs]. +-- + //// [source,console] ---- diff --git a/docs/reference/behavioral-analytics/apis/index.asciidoc b/docs/reference/behavioral-analytics/apis/index.asciidoc index 692d3374f89f..6dc12599c229 100644 --- a/docs/reference/behavioral-analytics/apis/index.asciidoc +++ b/docs/reference/behavioral-analytics/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-analytics[Behavioral analytics APIs]. +-- + Use the following APIs to manage tasks and resources related to <>: * <> diff --git a/docs/reference/behavioral-analytics/apis/list-analytics-collection.asciidoc b/docs/reference/behavioral-analytics/apis/list-analytics-collection.asciidoc index 14511a125827..46ee8296f3eb 100644 --- a/docs/reference/behavioral-analytics/apis/list-analytics-collection.asciidoc +++ b/docs/reference/behavioral-analytics/apis/list-analytics-collection.asciidoc @@ -8,6 +8,12 @@ beta::[] List Analytics Collections ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-analytics[Behavioral analytics APIs]. +-- + //// [source,console] ---- diff --git a/docs/reference/behavioral-analytics/apis/post-analytics-collection-event.asciidoc b/docs/reference/behavioral-analytics/apis/post-analytics-collection-event.asciidoc index f82717e22ed3..60985cd50d3d 100644 --- a/docs/reference/behavioral-analytics/apis/post-analytics-collection-event.asciidoc +++ b/docs/reference/behavioral-analytics/apis/post-analytics-collection-event.asciidoc @@ -8,6 +8,12 @@ beta::[] Post Analytics Collection Event ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-analytics[Behavioral analytics APIs]. +-- + //// [source,console] ---- diff --git a/docs/reference/behavioral-analytics/apis/put-analytics-collection.asciidoc b/docs/reference/behavioral-analytics/apis/put-analytics-collection.asciidoc index cbbab2ae3e26..412277afa207 100644 --- a/docs/reference/behavioral-analytics/apis/put-analytics-collection.asciidoc +++ b/docs/reference/behavioral-analytics/apis/put-analytics-collection.asciidoc @@ -8,6 +8,12 @@ beta::[] Put Analytics Collection ++++ +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-analytics[Behavioral analytics APIs]. +-- + //// [source,console] ---- diff --git a/docs/reference/cat.asciidoc b/docs/reference/cat.asciidoc index 328970e1d9dc..61ec9f7680f7 100644 --- a/docs/reference/cat.asciidoc +++ b/docs/reference/cat.asciidoc @@ -1,6 +1,12 @@ [[cat]] == Compact and aligned text (CAT) APIs +.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]. +-- + ["float",id="intro"] === Introduction diff --git a/docs/reference/cat/alias.asciidoc b/docs/reference/cat/alias.asciidoc index b6459eaa93b8..b52cf8f8700f 100644 --- a/docs/reference/cat/alias.asciidoc +++ b/docs/reference/cat/alias.asciidoc @@ -4,6 +4,12 @@ cat aliases ++++ +..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].. +-- + [IMPORTANT] ==== cat APIs are only intended for human consumption using the command line or the diff --git a/docs/reference/cat/allocation.asciidoc b/docs/reference/cat/allocation.asciidoc index 0891406d1be4..efe635f4f310 100644 --- a/docs/reference/cat/allocation.asciidoc +++ b/docs/reference/cat/allocation.asciidoc @@ -4,6 +4,12 @@ cat allocation ++++ +..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].. +-- + [IMPORTANT] ==== cat APIs are only intended for human consumption using the command line or {kib} diff --git a/docs/reference/cat/anomaly-detectors.asciidoc b/docs/reference/cat/anomaly-detectors.asciidoc index 3416c256881a..7a5c9115b467 100644 --- a/docs/reference/cat/anomaly-detectors.asciidoc +++ b/docs/reference/cat/anomaly-detectors.asciidoc @@ -5,6 +5,12 @@ cat anomaly detectors ++++ +..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].. +-- + [IMPORTANT] ==== cat APIs are only intended for human consumption using the command line or {kib} diff --git a/docs/reference/cat/component-templates.asciidoc b/docs/reference/cat/component-templates.asciidoc index f87f400bb888..2127edf062f2 100644 --- a/docs/reference/cat/component-templates.asciidoc +++ b/docs/reference/cat/component-templates.asciidoc @@ -4,6 +4,12 @@ cat component templates ++++ +..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].. +-- + [IMPORTANT] ==== cat APIs are only intended for human consumption using the command line or {kib} diff --git a/docs/reference/cat/count.asciidoc b/docs/reference/cat/count.asciidoc index 37e602c75902..39c5b5b798d8 100644 --- a/docs/reference/cat/count.asciidoc +++ b/docs/reference/cat/count.asciidoc @@ -4,6 +4,12 @@ cat count ++++ +..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].. +-- + [IMPORTANT] ==== cat APIs are only intended for human consumption using the command line or {kib} diff --git a/docs/reference/cat/datafeeds.asciidoc b/docs/reference/cat/datafeeds.asciidoc index 9b6481191e59..0771bcf06282 100644 --- a/docs/reference/cat/datafeeds.asciidoc +++ b/docs/reference/cat/datafeeds.asciidoc @@ -5,6 +5,12 @@ cat {dfeeds} ++++ +..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].. +-- + [IMPORTANT] ==== cat APIs are only intended for human consumption using the command line or {kib} diff --git a/docs/reference/cat/dataframeanalytics.asciidoc b/docs/reference/cat/dataframeanalytics.asciidoc index 4c236ecf61ff..fbdd42a3b5e9 100644 --- a/docs/reference/cat/dataframeanalytics.asciidoc +++ b/docs/reference/cat/dataframeanalytics.asciidoc @@ -5,6 +5,12 @@ cat {dfanalytics} ++++ +..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].. +-- + [IMPORTANT] ==== cat APIs are only intended for human consumption using the command line or {kib} diff --git a/docs/reference/cat/fielddata.asciidoc b/docs/reference/cat/fielddata.asciidoc index 376ef1d97057..22c0d532f212 100644 --- a/docs/reference/cat/fielddata.asciidoc +++ b/docs/reference/cat/fielddata.asciidoc @@ -4,6 +4,12 @@ cat fielddata ++++ +..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].. +-- + [IMPORTANT] ==== cat APIs are only intended for human consumption using the command line or {kib} diff --git a/docs/reference/cat/health.asciidoc b/docs/reference/cat/health.asciidoc index ad39ace31080..70e7960b0357 100644 --- a/docs/reference/cat/health.asciidoc +++ b/docs/reference/cat/health.asciidoc @@ -4,6 +4,12 @@ cat health ++++ +..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].. +-- + [IMPORTANT] ==== cat APIs are only intended for human consumption using the command line or {kib} diff --git a/docs/reference/cat/indices.asciidoc b/docs/reference/cat/indices.asciidoc index 65797e38401b..12a299b0e51e 100644 --- a/docs/reference/cat/indices.asciidoc +++ b/docs/reference/cat/indices.asciidoc @@ -4,6 +4,12 @@ cat indices ++++ +..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].. +-- + [IMPORTANT] ==== cat APIs are only intended for human consumption using the command line or {kib} diff --git a/docs/reference/cat/master.asciidoc b/docs/reference/cat/master.asciidoc index 42348fc4939d..889c44cd9cc7 100644 --- a/docs/reference/cat/master.asciidoc +++ b/docs/reference/cat/master.asciidoc @@ -4,6 +4,12 @@ cat master ++++ +..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].. +-- + [IMPORTANT] ==== cat APIs are only intended for human consumption using the command line or {kib} diff --git a/docs/reference/cat/nodeattrs.asciidoc b/docs/reference/cat/nodeattrs.asciidoc index 2db0c3fc2027..b372fb0b7dd6 100644 --- a/docs/reference/cat/nodeattrs.asciidoc +++ b/docs/reference/cat/nodeattrs.asciidoc @@ -4,6 +4,12 @@ cat nodeattrs ++++ +..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].. +-- + [IMPORTANT] ==== cat APIs are only intended for human consumption using the command line or {kib} diff --git a/docs/reference/cat/nodes.asciidoc b/docs/reference/cat/nodes.asciidoc index 5f329c00efd7..b369a747a152 100644 --- a/docs/reference/cat/nodes.asciidoc +++ b/docs/reference/cat/nodes.asciidoc @@ -5,6 +5,12 @@ cat nodes ++++ +..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].. +-- + [IMPORTANT] ==== cat APIs are only intended for human consumption using the command line or {kib} diff --git a/docs/reference/cat/pending_tasks.asciidoc b/docs/reference/cat/pending_tasks.asciidoc index 5dd6cb068814..3a97542e0f01 100644 --- a/docs/reference/cat/pending_tasks.asciidoc +++ b/docs/reference/cat/pending_tasks.asciidoc @@ -4,6 +4,12 @@ cat pending tasks ++++ +..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].. +-- + [IMPORTANT] ==== cat APIs are only intended for human consumption using the command line or {kib} diff --git a/docs/reference/cat/plugins.asciidoc b/docs/reference/cat/plugins.asciidoc index a812556887b7..3efa7c9ea582 100644 --- a/docs/reference/cat/plugins.asciidoc +++ b/docs/reference/cat/plugins.asciidoc @@ -4,6 +4,11 @@ cat plugins ++++ +..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].. +-- [IMPORTANT] ==== diff --git a/docs/reference/cat/recovery.asciidoc b/docs/reference/cat/recovery.asciidoc index c3292fc9971e..192c3e2d6506 100644 --- a/docs/reference/cat/recovery.asciidoc +++ b/docs/reference/cat/recovery.asciidoc @@ -4,6 +4,12 @@ cat recovery ++++ +..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].. +-- + [IMPORTANT] ==== cat APIs are only intended for human consumption using the command line or {kib} diff --git a/docs/reference/cat/repositories.asciidoc b/docs/reference/cat/repositories.asciidoc index ec2f243c27be..140bcf8ee702 100644 --- a/docs/reference/cat/repositories.asciidoc +++ b/docs/reference/cat/repositories.asciidoc @@ -4,6 +4,12 @@ cat repositories ++++ +..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].. +-- + [IMPORTANT] ==== cat APIs are only intended for human consumption using the command line or {kib} diff --git a/docs/reference/cat/segments.asciidoc b/docs/reference/cat/segments.asciidoc index 872af679642d..45b1d71a241a 100644 --- a/docs/reference/cat/segments.asciidoc +++ b/docs/reference/cat/segments.asciidoc @@ -4,6 +4,12 @@ cat segments ++++ +..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].. +-- + [IMPORTANT] ==== cat APIs are only intended for human consumption using the command line or {kib} diff --git a/docs/reference/cat/shards.asciidoc b/docs/reference/cat/shards.asciidoc index 12633e8ab262..8227cd856fd9 100644 --- a/docs/reference/cat/shards.asciidoc +++ b/docs/reference/cat/shards.asciidoc @@ -5,6 +5,12 @@ cat shards ++++ +..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].. +-- + [IMPORTANT] ==== cat APIs are only intended for human consumption using the command line or {kib} diff --git a/docs/reference/cat/snapshots.asciidoc b/docs/reference/cat/snapshots.asciidoc index 820c4b56c783..27fdc6eb486d 100644 --- a/docs/reference/cat/snapshots.asciidoc +++ b/docs/reference/cat/snapshots.asciidoc @@ -4,6 +4,12 @@ cat snapshots ++++ +..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].. +-- + [IMPORTANT] ==== cat APIs are only intended for human consumption using the command line or {kib} diff --git a/docs/reference/cat/tasks.asciidoc b/docs/reference/cat/tasks.asciidoc index 91d67baa72d7..6745381f6bab 100644 --- a/docs/reference/cat/tasks.asciidoc +++ b/docs/reference/cat/tasks.asciidoc @@ -6,6 +6,12 @@ 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 +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs].. +-- + [IMPORTANT] ==== cat APIs are only intended for human consumption using the command line or {kib} diff --git a/docs/reference/cat/templates.asciidoc b/docs/reference/cat/templates.asciidoc index bcc8e9e4f5dc..624ae244d6f0 100644 --- a/docs/reference/cat/templates.asciidoc +++ b/docs/reference/cat/templates.asciidoc @@ -4,6 +4,12 @@ cat templates ++++ +..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].. +-- + [IMPORTANT] ==== cat APIs are only intended for human consumption using the command line or {kib} diff --git a/docs/reference/cat/thread_pool.asciidoc b/docs/reference/cat/thread_pool.asciidoc index 948ed9a1a7a3..7e7d20b77fc7 100644 --- a/docs/reference/cat/thread_pool.asciidoc +++ b/docs/reference/cat/thread_pool.asciidoc @@ -4,6 +4,12 @@ cat thread pool ++++ +..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].. +-- + [IMPORTANT] ==== cat APIs are only intended for human consumption using the command line or {kib} diff --git a/docs/reference/cat/trainedmodel.asciidoc b/docs/reference/cat/trainedmodel.asciidoc index 74e83525ddfe..8203e33056ae 100644 --- a/docs/reference/cat/trainedmodel.asciidoc +++ b/docs/reference/cat/trainedmodel.asciidoc @@ -5,6 +5,12 @@ cat trained model ++++ +..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].. +-- + [IMPORTANT] ==== cat APIs are only intended for human consumption using the command line or {kib} diff --git a/docs/reference/cat/transforms.asciidoc b/docs/reference/cat/transforms.asciidoc index 0d4e9b691ac5..0fc01ade1d09 100644 --- a/docs/reference/cat/transforms.asciidoc +++ b/docs/reference/cat/transforms.asciidoc @@ -5,6 +5,12 @@ cat transforms ++++ +..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].. +-- + [IMPORTANT] ==== cat APIs are only intended for human consumption using the command line or {kib} 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 b510163bab50..18cf723901b5 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,6 +5,12 @@ Delete auto-follow pattern ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. +-- + Delete {ccr} <>. [[ccr-delete-auto-follow-pattern-request]] 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 a2969e993ddf..b4fd82008836 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,6 +5,12 @@ Get auto-follow pattern ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. +-- + Get {ccr} <>. [[ccr-get-auto-follow-pattern-request]] 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 c5ae5a7b4af9..2d70b8da92b4 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,6 +5,12 @@ Pause auto-follow pattern ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. +-- + Pauses a {ccr} <>. [[ccr-pause-auto-follow-pattern-request]] 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 6769f21ca5ce..9b25bf174659 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,6 +5,12 @@ Create auto-follow pattern ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. +-- + Creates a {ccr} <>. [[ccr-put-auto-follow-pattern-request]] 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 a580bb3838f9..345b5e764547 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,6 +5,12 @@ Resume auto-follow pattern ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. +-- + Resumes a {ccr} <>. [[ccr-resume-auto-follow-pattern-request]] diff --git a/docs/reference/ccr/apis/ccr-apis.asciidoc b/docs/reference/ccr/apis/ccr-apis.asciidoc index ae94e1931af8..21e859a0bff9 100644 --- a/docs/reference/ccr/apis/ccr-apis.asciidoc +++ b/docs/reference/ccr/apis/ccr-apis.asciidoc @@ -2,6 +2,12 @@ [[ccr-apis]] == {ccr-cap} APIs +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. +-- + You can use the following APIs to perform <> operations. [discrete] diff --git a/docs/reference/ccr/apis/follow/get-follow-info.asciidoc b/docs/reference/ccr/apis/follow/get-follow-info.asciidoc index 6c049d9c92b5..a913e2e2bd15 100644 --- a/docs/reference/ccr/apis/follow/get-follow-info.asciidoc +++ b/docs/reference/ccr/apis/follow/get-follow-info.asciidoc @@ -5,6 +5,12 @@ Get follower info ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. +-- + Retrieves information about all <> follower indices. [[ccr-get-follow-info-request]] diff --git a/docs/reference/ccr/apis/follow/get-follow-stats.asciidoc b/docs/reference/ccr/apis/follow/get-follow-stats.asciidoc index 4892f86b3523..ff0a72a8b234 100644 --- a/docs/reference/ccr/apis/follow/get-follow-stats.asciidoc +++ b/docs/reference/ccr/apis/follow/get-follow-stats.asciidoc @@ -5,6 +5,12 @@ Get follower stats ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. +-- + Get <> follower stats. [[ccr-get-follow-stats-request]] diff --git a/docs/reference/ccr/apis/follow/post-forget-follower.asciidoc b/docs/reference/ccr/apis/follow/post-forget-follower.asciidoc index 1917c08d6640..b6f397647817 100644 --- a/docs/reference/ccr/apis/follow/post-forget-follower.asciidoc +++ b/docs/reference/ccr/apis/follow/post-forget-follower.asciidoc @@ -5,6 +5,12 @@ Forget follower ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. +-- + Removes the <> follower retention leases from the leader. [[ccr-post-forget-follower-request]] diff --git a/docs/reference/ccr/apis/follow/post-pause-follow.asciidoc b/docs/reference/ccr/apis/follow/post-pause-follow.asciidoc index 6d4730d10efe..f5ce00cbfccf 100644 --- a/docs/reference/ccr/apis/follow/post-pause-follow.asciidoc +++ b/docs/reference/ccr/apis/follow/post-pause-follow.asciidoc @@ -5,6 +5,12 @@ Pause follower ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. +-- + Pauses a <> follower index. [[ccr-post-pause-follow-request]] diff --git a/docs/reference/ccr/apis/follow/post-resume-follow.asciidoc b/docs/reference/ccr/apis/follow/post-resume-follow.asciidoc index b023a8cb5cb7..7bca84827be1 100644 --- a/docs/reference/ccr/apis/follow/post-resume-follow.asciidoc +++ b/docs/reference/ccr/apis/follow/post-resume-follow.asciidoc @@ -5,6 +5,12 @@ Resume follower ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. +-- + Resumes a <> follower index. [[ccr-post-resume-follow-request]] diff --git a/docs/reference/ccr/apis/follow/post-unfollow.asciidoc b/docs/reference/ccr/apis/follow/post-unfollow.asciidoc index dab11ef9e7a5..933e3c567446 100644 --- a/docs/reference/ccr/apis/follow/post-unfollow.asciidoc +++ b/docs/reference/ccr/apis/follow/post-unfollow.asciidoc @@ -5,6 +5,12 @@ Unfollow ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. +-- + Converts a <> follower index to a regular index. [[ccr-post-unfollow-request]] diff --git a/docs/reference/ccr/apis/follow/put-follow.asciidoc b/docs/reference/ccr/apis/follow/put-follow.asciidoc index b7ae9ac98747..97a4948c43a7 100644 --- a/docs/reference/ccr/apis/follow/put-follow.asciidoc +++ b/docs/reference/ccr/apis/follow/put-follow.asciidoc @@ -5,6 +5,12 @@ Create follower ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. +-- + Creates a <> follower index. [[ccr-put-follow-request]] diff --git a/docs/reference/ccr/apis/get-ccr-stats.asciidoc b/docs/reference/ccr/apis/get-ccr-stats.asciidoc index 92e6bae0bdce..69dae2ca6966 100644 --- a/docs/reference/ccr/apis/get-ccr-stats.asciidoc +++ b/docs/reference/ccr/apis/get-ccr-stats.asciidoc @@ -6,6 +6,12 @@ Get {ccr-init} stats ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs]. +-- + Get <> stats. [[ccr-get-stats-request]] diff --git a/docs/reference/cluster.asciidoc b/docs/reference/cluster.asciidoc index 3de386d3288c..b4359c2bf4fb 100644 --- a/docs/reference/cluster.asciidoc +++ b/docs/reference/cluster.asciidoc @@ -1,6 +1,12 @@ [[cluster]] == Cluster APIs +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. +-- + ["float",id="cluster-nodes"] === Node specification diff --git a/docs/reference/cluster/allocation-explain.asciidoc b/docs/reference/cluster/allocation-explain.asciidoc index 81e253ba0321..c3aae19e8e34 100644 --- a/docs/reference/cluster/allocation-explain.asciidoc +++ b/docs/reference/cluster/allocation-explain.asciidoc @@ -4,6 +4,12 @@ Cluster allocation explain ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. +-- + Provides an explanation for a shard's current <>. [source,console] diff --git a/docs/reference/cluster/cluster-info.asciidoc b/docs/reference/cluster/cluster-info.asciidoc index 7d67f1602aea..2106fcfc6975 100644 --- a/docs/reference/cluster/cluster-info.asciidoc +++ b/docs/reference/cluster/cluster-info.asciidoc @@ -7,6 +7,12 @@ experimental::[] Cluster Info ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. +-- + Returns cluster information. [[cluster-info-api-request]] diff --git a/docs/reference/cluster/delete-desired-balance.asciidoc b/docs/reference/cluster/delete-desired-balance.asciidoc index c67834269e50..49b555fd5005 100644 --- a/docs/reference/cluster/delete-desired-balance.asciidoc +++ b/docs/reference/cluster/delete-desired-balance.asciidoc @@ -6,6 +6,12 @@ NOTE: {cloud-only} +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. +-- + Discards the current <> and computes a new desired balance starting from the current allocation of shards. This can sometimes help {es} find a desired balance which needs fewer shard movements to achieve, especially if the cluster has experienced changes so substantial that the current desired balance is no longer optimal without {es} having diff --git a/docs/reference/cluster/delete-desired-nodes.asciidoc b/docs/reference/cluster/delete-desired-nodes.asciidoc index a58d19e2dfa3..93e8f6484895 100644 --- a/docs/reference/cluster/delete-desired-nodes.asciidoc +++ b/docs/reference/cluster/delete-desired-nodes.asciidoc @@ -6,6 +6,12 @@ NOTE: {cloud-only} +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. +-- + Delete desired nodes. [[delete-desired-nodes-request]] diff --git a/docs/reference/cluster/get-desired-balance.asciidoc b/docs/reference/cluster/get-desired-balance.asciidoc index 74afdaa52daf..381f263a5ee7 100644 --- a/docs/reference/cluster/get-desired-balance.asciidoc +++ b/docs/reference/cluster/get-desired-balance.asciidoc @@ -6,6 +6,12 @@ NOTE: {cloud-only} +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. +-- + Exposes: * the <> computation and reconciliation stats diff --git a/docs/reference/cluster/get-desired-nodes.asciidoc b/docs/reference/cluster/get-desired-nodes.asciidoc index de27bd657b3f..c4182a37b2d0 100644 --- a/docs/reference/cluster/get-desired-nodes.asciidoc +++ b/docs/reference/cluster/get-desired-nodes.asciidoc @@ -6,6 +6,12 @@ NOTE: {cloud-only} +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. +-- + Get desired nodes. [[get-desired-nodes-request]] diff --git a/docs/reference/cluster/get-settings.asciidoc b/docs/reference/cluster/get-settings.asciidoc index 32c186e4ef24..0b577356aa76 100644 --- a/docs/reference/cluster/get-settings.asciidoc +++ b/docs/reference/cluster/get-settings.asciidoc @@ -4,6 +4,12 @@ Cluster get settings ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. +-- + Returns cluster-wide settings. [source,console] diff --git a/docs/reference/cluster/health.asciidoc b/docs/reference/cluster/health.asciidoc index 94eb80a03d12..b24b408964d3 100644 --- a/docs/reference/cluster/health.asciidoc +++ b/docs/reference/cluster/health.asciidoc @@ -4,6 +4,12 @@ Cluster health ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. +-- + Returns the health status of a cluster. [[cluster-health-api-request]] diff --git a/docs/reference/cluster/nodes-hot-threads.asciidoc b/docs/reference/cluster/nodes-hot-threads.asciidoc index 446a8fede69e..f78719772d5a 100644 --- a/docs/reference/cluster/nodes-hot-threads.asciidoc +++ b/docs/reference/cluster/nodes-hot-threads.asciidoc @@ -4,6 +4,12 @@ Nodes hot threads ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. +-- + Returns the hot threads on each selected node in the cluster. [[cluster-nodes-hot-threads-api-request]] diff --git a/docs/reference/cluster/nodes-info.asciidoc b/docs/reference/cluster/nodes-info.asciidoc index 6f1d769e696c..32959eda3176 100644 --- a/docs/reference/cluster/nodes-info.asciidoc +++ b/docs/reference/cluster/nodes-info.asciidoc @@ -4,8 +4,13 @@ Nodes info ++++ -Returns cluster nodes information. +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. +-- +Returns cluster nodes information. [[cluster-nodes-info-api-request]] ==== {api-request-title} diff --git a/docs/reference/cluster/nodes-reload-secure-settings.asciidoc b/docs/reference/cluster/nodes-reload-secure-settings.asciidoc index f86304d2e9ba..0db189a4a396 100644 --- a/docs/reference/cluster/nodes-reload-secure-settings.asciidoc +++ b/docs/reference/cluster/nodes-reload-secure-settings.asciidoc @@ -4,6 +4,12 @@ Nodes reload secure settings ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. +-- + Reloads the keystore on nodes in the cluster. [[cluster-nodes-reload-secure-settings-api-request]] diff --git a/docs/reference/cluster/nodes-stats.asciidoc b/docs/reference/cluster/nodes-stats.asciidoc index adf8229712ec..b1c6d3ab466a 100644 --- a/docs/reference/cluster/nodes-stats.asciidoc +++ b/docs/reference/cluster/nodes-stats.asciidoc @@ -5,6 +5,12 @@ Nodes stats ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. +-- + Returns cluster nodes statistics. [[cluster-nodes-stats-api-request]] diff --git a/docs/reference/cluster/nodes-usage.asciidoc b/docs/reference/cluster/nodes-usage.asciidoc index 486edf67bba8..58815b86a881 100644 --- a/docs/reference/cluster/nodes-usage.asciidoc +++ b/docs/reference/cluster/nodes-usage.asciidoc @@ -4,8 +4,13 @@ Nodes feature usage ++++ -Returns information on the usage of features. +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. +-- +Returns information on the usage of features. [[cluster-nodes-usage-api-request]] ==== {api-request-title} diff --git a/docs/reference/cluster/pending.asciidoc b/docs/reference/cluster/pending.asciidoc index 3e87234c7d26..dd5146d0f04d 100644 --- a/docs/reference/cluster/pending.asciidoc +++ b/docs/reference/cluster/pending.asciidoc @@ -4,6 +4,12 @@ Pending cluster tasks ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. +-- + Returns cluster-level changes that have not yet been executed. diff --git a/docs/reference/cluster/prevalidate-node-removal.asciidoc b/docs/reference/cluster/prevalidate-node-removal.asciidoc index 16bf28c58668..d2c2fe562d56 100644 --- a/docs/reference/cluster/prevalidate-node-removal.asciidoc +++ b/docs/reference/cluster/prevalidate-node-removal.asciidoc @@ -6,6 +6,12 @@ NOTE: {cloud-only} +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. +-- + Prevalidate node removal. [[prevalidate-node-removal-api-request]] diff --git a/docs/reference/cluster/remote-info.asciidoc b/docs/reference/cluster/remote-info.asciidoc index 8f2923846df0..bbfc44b6b555 100644 --- a/docs/reference/cluster/remote-info.asciidoc +++ b/docs/reference/cluster/remote-info.asciidoc @@ -4,8 +4,13 @@ Remote cluster info ++++ -Returns configured remote cluster information. +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. +-- +Returns configured remote cluster information. [[cluster-remote-info-api-request]] ==== {api-request-title} diff --git a/docs/reference/cluster/reroute.asciidoc b/docs/reference/cluster/reroute.asciidoc index b4e4809ae73b..eaca7f9171e8 100644 --- a/docs/reference/cluster/reroute.asciidoc +++ b/docs/reference/cluster/reroute.asciidoc @@ -4,8 +4,13 @@ Cluster reroute ++++ -Changes the allocation of shards in a cluster. +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. +-- +Changes the allocation of shards in a cluster. [[cluster-reroute-api-request]] ==== {api-request-title} diff --git a/docs/reference/cluster/state.asciidoc b/docs/reference/cluster/state.asciidoc index fcb2f5f2f5dc..cda375c514c3 100644 --- a/docs/reference/cluster/state.asciidoc +++ b/docs/reference/cluster/state.asciidoc @@ -4,6 +4,12 @@ Cluster state ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. +-- + Returns an internal representation of the cluster state for debugging or diagnostic purposes. diff --git a/docs/reference/cluster/stats.asciidoc b/docs/reference/cluster/stats.asciidoc index d875417bde51..278ac8ec7821 100644 --- a/docs/reference/cluster/stats.asciidoc +++ b/docs/reference/cluster/stats.asciidoc @@ -5,6 +5,12 @@ Cluster stats ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. +-- + Returns cluster statistics. [[cluster-stats-api-request]] diff --git a/docs/reference/cluster/tasks.asciidoc b/docs/reference/cluster/tasks.asciidoc index 4b32d5f1b903..4d8703900337 100644 --- a/docs/reference/cluster/tasks.asciidoc +++ b/docs/reference/cluster/tasks.asciidoc @@ -6,6 +6,12 @@ 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 +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-tasks[task management APIs]. +-- + Returns information about the tasks currently executing in the cluster. [[tasks-api-request]] diff --git a/docs/reference/cluster/update-desired-nodes.asciidoc b/docs/reference/cluster/update-desired-nodes.asciidoc index c72a2b53208e..edcaeb745e7a 100644 --- a/docs/reference/cluster/update-desired-nodes.asciidoc +++ b/docs/reference/cluster/update-desired-nodes.asciidoc @@ -6,6 +6,12 @@ NOTE: {cloud-only} +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. +-- + Creates or updates the desired nodes. [[update-desired-nodes-request]] diff --git a/docs/reference/cluster/update-settings.asciidoc b/docs/reference/cluster/update-settings.asciidoc index ca3d100e31e0..add62f88bcf8 100644 --- a/docs/reference/cluster/update-settings.asciidoc +++ b/docs/reference/cluster/update-settings.asciidoc @@ -4,8 +4,13 @@ Cluster update settings ++++ -Configures <>. +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. +-- +Configures <>. [[cluster-update-settings-api-request]] ==== {api-request-title} diff --git a/docs/reference/cluster/voting-exclusions.asciidoc b/docs/reference/cluster/voting-exclusions.asciidoc index 55587a7010f8..f1aa03c6550b 100644 --- a/docs/reference/cluster/voting-exclusions.asciidoc +++ b/docs/reference/cluster/voting-exclusions.asciidoc @@ -4,6 +4,12 @@ Voting configuration exclusions ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs]. +-- + Adds or removes master-eligible nodes from the <>. 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 8cd8f71dc7ae..0c3b7350d0aa 100644 --- a/docs/reference/connector/apis/cancel-connector-sync-job-api.asciidoc +++ b/docs/reference/connector/apis/cancel-connector-sync-job-api.asciidoc @@ -6,6 +6,12 @@ beta::[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. +-- + Cancels a connector sync job. To get started with Connector APIs, check out <>. diff --git a/docs/reference/connector/apis/check-in-connector-api.asciidoc b/docs/reference/connector/apis/check-in-connector-api.asciidoc index 15e65b10074d..808f835a7484 100644 --- a/docs/reference/connector/apis/check-in-connector-api.asciidoc +++ b/docs/reference/connector/apis/check-in-connector-api.asciidoc @@ -6,6 +6,12 @@ preview::[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. +-- + Updates the `last_seen` field of a connector with current timestamp. To get started with Connector APIs, check out <>. 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 8d7d0a36ad88..1aa5762e8e6f 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,6 +6,12 @@ preview::[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. +-- + Checks in a connector sync job (updates `last_seen` to the current time). To get started with Connector APIs, check out <>. 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 62491582ce75..c8de1efa07f2 100644 --- a/docs/reference/connector/apis/claim-connector-sync-job-api.asciidoc +++ b/docs/reference/connector/apis/claim-connector-sync-job-api.asciidoc @@ -6,6 +6,12 @@ preview::[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. +-- + Claims a connector sync job. The `_claim` endpoint is not intended for direct connector management by users. It is there to support the implementation of services that utilize the https://github.com/elastic/connectors/blob/main/docs/CONNECTOR_PROTOCOL.md[Connector Protocol] to communicate with {es}. diff --git a/docs/reference/connector/apis/connector-apis.asciidoc b/docs/reference/connector/apis/connector-apis.asciidoc index 15ce31a60598..33b58abd193b 100644 --- a/docs/reference/connector/apis/connector-apis.asciidoc +++ b/docs/reference/connector/apis/connector-apis.asciidoc @@ -1,6 +1,12 @@ [[connector-apis]] == Connector APIs +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. +-- + beta::[] The connector and sync jobs APIs provide a convenient way to create and manage Elastic <>. diff --git a/docs/reference/connector/apis/create-connector-api.asciidoc b/docs/reference/connector/apis/create-connector-api.asciidoc index 3ecef6d30273..3b7ffd4b4255 100644 --- a/docs/reference/connector/apis/create-connector-api.asciidoc +++ b/docs/reference/connector/apis/create-connector-api.asciidoc @@ -6,6 +6,12 @@ beta::[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. +-- + Creates an Elastic connector. Connectors are {es} integrations that bring content from third-party data sources, which can be deployed on {ecloud} or hosted on your own infrastructure: 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 240ab696954f..58608bfd7fbd 100644 --- a/docs/reference/connector/apis/create-connector-sync-job-api.asciidoc +++ b/docs/reference/connector/apis/create-connector-sync-job-api.asciidoc @@ -6,6 +6,11 @@ beta::[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. +-- Creates a connector sync job. diff --git a/docs/reference/connector/apis/delete-connector-api.asciidoc b/docs/reference/connector/apis/delete-connector-api.asciidoc index 76621d7f1843..ae2c2ac3b424 100644 --- a/docs/reference/connector/apis/delete-connector-api.asciidoc +++ b/docs/reference/connector/apis/delete-connector-api.asciidoc @@ -6,6 +6,12 @@ beta::[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. +-- + Removes a connector and associated sync jobs. This is a destructive action that is not recoverable. 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 eeea40f430ab..67666392ad19 100644 --- a/docs/reference/connector/apis/delete-connector-sync-job-api.asciidoc +++ b/docs/reference/connector/apis/delete-connector-sync-job-api.asciidoc @@ -6,6 +6,12 @@ beta::[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. +-- + Removes a connector sync job and its associated data. This is a destructive action that is not recoverable. diff --git a/docs/reference/connector/apis/get-connector-api.asciidoc b/docs/reference/connector/apis/get-connector-api.asciidoc index 302773e0af83..50ec84617b9d 100644 --- a/docs/reference/connector/apis/get-connector-api.asciidoc +++ b/docs/reference/connector/apis/get-connector-api.asciidoc @@ -6,6 +6,12 @@ beta::[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. +-- + Retrieves the details about a connector. To get started with Connector APIs, check out <>. 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 a524c1291c26..e30b0e4ec98d 100644 --- a/docs/reference/connector/apis/get-connector-sync-job-api.asciidoc +++ b/docs/reference/connector/apis/get-connector-sync-job-api.asciidoc @@ -6,6 +6,12 @@ beta::[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. +-- + Retrieves the details about a connector sync job. To get started with Connector APIs, check out <>. 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 4a4fa5a22dcc..9bcf9fbb4b8e 100644 --- a/docs/reference/connector/apis/list-connector-sync-jobs-api.asciidoc +++ b/docs/reference/connector/apis/list-connector-sync-jobs-api.asciidoc @@ -7,6 +7,12 @@ beta::[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. +-- + Returns information about all stored connector sync jobs ordered by their creation date in ascending order. To get started with Connector APIs, check out <>. diff --git a/docs/reference/connector/apis/list-connectors-api.asciidoc b/docs/reference/connector/apis/list-connectors-api.asciidoc index 4a93ecf2b010..9e7ea17bfaa3 100644 --- a/docs/reference/connector/apis/list-connectors-api.asciidoc +++ b/docs/reference/connector/apis/list-connectors-api.asciidoc @@ -7,6 +7,12 @@ beta::[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. +-- + Returns information about all created connectors. To get started with Connector APIs, check out <>. 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 e6ad9e8cc93d..2a29cd9ba54f 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,6 +6,12 @@ preview::[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. +-- + Sets a connector sync job error. To get started with Connector APIs, check out <>. 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 7e22f657ba6b..63c4a0ee152b 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,6 +6,12 @@ preview::[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. +-- + Sets connector sync job stats. To get started with Connector APIs, check out <>. 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 fbd3f887758f..440b8025138f 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,6 +6,12 @@ beta::[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. +-- + Updates the `api_key_id` and/or `api_key_secret_id` field(s) of a connector, specifying: . The ID of the API key used for authorization diff --git a/docs/reference/connector/apis/update-connector-configuration-api.asciidoc b/docs/reference/connector/apis/update-connector-configuration-api.asciidoc index 4b25f9e71ae4..a987b03c7674 100644 --- a/docs/reference/connector/apis/update-connector-configuration-api.asciidoc +++ b/docs/reference/connector/apis/update-connector-configuration-api.asciidoc @@ -6,6 +6,12 @@ beta::[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. +-- + Updates a connector's `configuration`, allowing for config value updates within a registered configuration schema. To get started with Connector APIs, check out <>. diff --git a/docs/reference/connector/apis/update-connector-error-api.asciidoc b/docs/reference/connector/apis/update-connector-error-api.asciidoc index 29358b243041..278f9377b91d 100644 --- a/docs/reference/connector/apis/update-connector-error-api.asciidoc +++ b/docs/reference/connector/apis/update-connector-error-api.asciidoc @@ -6,6 +6,12 @@ preview::[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. +-- + Updates the `error` field of a connector. To get started with Connector APIs, check out <>. diff --git a/docs/reference/connector/apis/update-connector-features-api.asciidoc b/docs/reference/connector/apis/update-connector-features-api.asciidoc index 77571fcd7d5a..d9da7b767e47 100644 --- a/docs/reference/connector/apis/update-connector-features-api.asciidoc +++ b/docs/reference/connector/apis/update-connector-features-api.asciidoc @@ -6,6 +6,12 @@ beta::[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. +-- + Manages the `features` of a connector. This endpoint can be used to control the following aspects of a connector: * document-level security diff --git a/docs/reference/connector/apis/update-connector-filtering-api.asciidoc b/docs/reference/connector/apis/update-connector-filtering-api.asciidoc index 4820fa151901..3cebee37b533 100644 --- a/docs/reference/connector/apis/update-connector-filtering-api.asciidoc +++ b/docs/reference/connector/apis/update-connector-filtering-api.asciidoc @@ -6,6 +6,12 @@ beta::[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. +-- + Updates the draft `filtering` configuration of a connector and marks the draft validation state as `edited`. The filtering draft is activated once validated by the running Elastic connector service. The filtering property is used to configure sync rules (both basic and advanced) for a connector. Learn more in the <>. 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 6222baf6a6ca..7a7e9fc535ef 100644 --- a/docs/reference/connector/apis/update-connector-index-name-api.asciidoc +++ b/docs/reference/connector/apis/update-connector-index-name-api.asciidoc @@ -6,6 +6,12 @@ beta::[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. +-- + Updates the `index_name` field of a connector, specifying the index where the data ingested by the connector is stored. To get started with Connector APIs, check out <>. 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 17f892d852f4..9fa3aeaa3a56 100644 --- a/docs/reference/connector/apis/update-connector-last-sync-api.asciidoc +++ b/docs/reference/connector/apis/update-connector-last-sync-api.asciidoc @@ -6,6 +6,12 @@ preview::[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. +-- + Updates the fields related to the last sync of a connector. This action is used for analytics and monitoring. 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 384cec2c73e2..0a0a63567706 100644 --- a/docs/reference/connector/apis/update-connector-name-description-api.asciidoc +++ b/docs/reference/connector/apis/update-connector-name-description-api.asciidoc @@ -6,6 +6,11 @@ beta::[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. +-- Updates the `name` and `description` fields of a connector. diff --git a/docs/reference/connector/apis/update-connector-pipeline-api.asciidoc b/docs/reference/connector/apis/update-connector-pipeline-api.asciidoc index e54b01ec47d0..666897a5f9a8 100644 --- a/docs/reference/connector/apis/update-connector-pipeline-api.asciidoc +++ b/docs/reference/connector/apis/update-connector-pipeline-api.asciidoc @@ -6,6 +6,12 @@ beta::[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. +-- + Updates the `pipeline` configuration of a connector. When you create a new connector, the configuration of an <> is populated with default settings. diff --git a/docs/reference/connector/apis/update-connector-scheduling-api.asciidoc b/docs/reference/connector/apis/update-connector-scheduling-api.asciidoc index 64302c26a723..af3b353eaf94 100644 --- a/docs/reference/connector/apis/update-connector-scheduling-api.asciidoc +++ b/docs/reference/connector/apis/update-connector-scheduling-api.asciidoc @@ -6,6 +6,12 @@ beta::[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. +-- + Updates the `scheduling` configuration of a connector. To get started with Connector APIs, check out <>. 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 c02967d03e2d..e92f8cd96b4c 100644 --- a/docs/reference/connector/apis/update-connector-service-type-api.asciidoc +++ b/docs/reference/connector/apis/update-connector-service-type-api.asciidoc @@ -6,6 +6,12 @@ beta::[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. +-- + Updates the `service_type` of a connector. To get started with Connector APIs, check out <>. diff --git a/docs/reference/connector/apis/update-connector-status-api.asciidoc b/docs/reference/connector/apis/update-connector-status-api.asciidoc index dadd93fe5f9c..910cc32605db 100644 --- a/docs/reference/connector/apis/update-connector-status-api.asciidoc +++ b/docs/reference/connector/apis/update-connector-status-api.asciidoc @@ -6,6 +6,12 @@ preview::[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-connector[Connector APIs]. +-- + Updates the `status` of a connector. To get started with Connector APIs, check out <>. diff --git a/docs/reference/data-streams/data-stream-apis.asciidoc b/docs/reference/data-streams/data-stream-apis.asciidoc index c13703ab2a6e..66662ef4a218 100644 --- a/docs/reference/data-streams/data-stream-apis.asciidoc +++ b/docs/reference/data-streams/data-stream-apis.asciidoc @@ -2,6 +2,12 @@ [[data-stream-apis]] == Data stream APIs +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. +-- + The following APIs are available for managing <>: * <> diff --git a/docs/reference/data-streams/lifecycle/apis/delete-lifecycle.asciidoc b/docs/reference/data-streams/lifecycle/apis/delete-lifecycle.asciidoc index 315f7fa85e45..70e901bb43b9 100644 --- a/docs/reference/data-streams/lifecycle/apis/delete-lifecycle.asciidoc +++ b/docs/reference/data-streams/lifecycle/apis/delete-lifecycle.asciidoc @@ -4,6 +4,12 @@ Delete Data Stream Lifecycle ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. +-- + Deletes the <> from a set of data streams. [[delete-lifecycle-api-prereqs]] diff --git a/docs/reference/data-streams/lifecycle/apis/explain-lifecycle.asciidoc b/docs/reference/data-streams/lifecycle/apis/explain-lifecycle.asciidoc index 2b15886ebe19..0a76114abfa0 100644 --- a/docs/reference/data-streams/lifecycle/apis/explain-lifecycle.asciidoc +++ b/docs/reference/data-streams/lifecycle/apis/explain-lifecycle.asciidoc @@ -4,6 +4,12 @@ Explain Data Stream Lifecycle ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. +-- + Retrieves the current <> status for one or more data stream backing indices. [[explain-lifecycle-api-prereqs]] 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 f48fa1eb52da..ba33574b4977 100644 --- a/docs/reference/data-streams/lifecycle/apis/get-lifecycle-stats.asciidoc +++ b/docs/reference/data-streams/lifecycle/apis/get-lifecycle-stats.asciidoc @@ -4,6 +4,12 @@ Get Data Stream Lifecycle ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. +-- + Gets stats about the execution of <>. [[get-lifecycle-stats-api-prereqs]] diff --git a/docs/reference/data-streams/lifecycle/apis/get-lifecycle.asciidoc b/docs/reference/data-streams/lifecycle/apis/get-lifecycle.asciidoc index 6323fac1eac2..32e68c0c3c31 100644 --- a/docs/reference/data-streams/lifecycle/apis/get-lifecycle.asciidoc +++ b/docs/reference/data-streams/lifecycle/apis/get-lifecycle.asciidoc @@ -4,6 +4,12 @@ Get Data Stream Lifecycle ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. +-- + Gets the <> of a set of <>. [[get-lifecycle-api-prereqs]] diff --git a/docs/reference/data-streams/lifecycle/apis/put-lifecycle.asciidoc b/docs/reference/data-streams/lifecycle/apis/put-lifecycle.asciidoc index c60c105e818a..e2eb52959c95 100644 --- a/docs/reference/data-streams/lifecycle/apis/put-lifecycle.asciidoc +++ b/docs/reference/data-streams/lifecycle/apis/put-lifecycle.asciidoc @@ -4,6 +4,12 @@ Put Data Stream Lifecycle ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. +-- + Configures the data stream <> for the targeted <>. [[put-lifecycle-api-prereqs]] diff --git a/docs/reference/data-streams/modify-data-streams-api.asciidoc b/docs/reference/data-streams/modify-data-streams-api.asciidoc index 2da869083df2..082034213467 100644 --- a/docs/reference/data-streams/modify-data-streams-api.asciidoc +++ b/docs/reference/data-streams/modify-data-streams-api.asciidoc @@ -4,6 +4,12 @@ Modify data streams ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. +-- + Performs one or more <> modification actions in a single atomic operation. diff --git a/docs/reference/data-streams/promote-data-stream-api.asciidoc b/docs/reference/data-streams/promote-data-stream-api.asciidoc index 111c7a2256f8..a050b9e014b7 100644 --- a/docs/reference/data-streams/promote-data-stream-api.asciidoc +++ b/docs/reference/data-streams/promote-data-stream-api.asciidoc @@ -5,6 +5,12 @@ Promote data stream ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. +-- + The purpose of the promote <> API is to turn a data stream that is replicated by CCR into a regular data stream. diff --git a/docs/reference/docs.asciidoc b/docs/reference/docs.asciidoc index ff2d823410a6..34662401842f 100644 --- a/docs/reference/docs.asciidoc +++ b/docs/reference/docs.asciidoc @@ -1,6 +1,12 @@ [[docs]] == Document APIs +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-document[Document APIs]. +-- + This section starts with a short introduction to {es}'s <>, followed by a detailed description of the following CRUD APIs: diff --git a/docs/reference/docs/bulk.asciidoc b/docs/reference/docs/bulk.asciidoc index 69bf3d1b7db5..9b12efb466ca 100644 --- a/docs/reference/docs/bulk.asciidoc +++ b/docs/reference/docs/bulk.asciidoc @@ -4,6 +4,12 @@ Bulk ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-document[Document APIs]. +-- + Performs multiple indexing or delete operations in a single API call. This reduces overhead and can greatly increase indexing speed. diff --git a/docs/reference/docs/delete.asciidoc b/docs/reference/docs/delete.asciidoc index 452d7f7758bf..966561909663 100644 --- a/docs/reference/docs/delete.asciidoc +++ b/docs/reference/docs/delete.asciidoc @@ -4,6 +4,12 @@ Delete ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-document[Document APIs]. +-- + Removes a JSON document from the specified index. [[docs-delete-api-request]] diff --git a/docs/reference/docs/get.asciidoc b/docs/reference/docs/get.asciidoc index c71215fff8d7..bdbcb08e186c 100644 --- a/docs/reference/docs/get.asciidoc +++ b/docs/reference/docs/get.asciidoc @@ -4,6 +4,12 @@ Get ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-document[Document APIs]. +-- + Retrieves the specified JSON document from an index. [source,console] diff --git a/docs/reference/docs/multi-get.asciidoc b/docs/reference/docs/multi-get.asciidoc index 7c3eafa9c79f..b27bd6a97d53 100644 --- a/docs/reference/docs/multi-get.asciidoc +++ b/docs/reference/docs/multi-get.asciidoc @@ -4,6 +4,12 @@ Multi get ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-document[Document APIs]. +-- + Retrieves multiple JSON documents by ID. [source,console] diff --git a/docs/reference/docs/reindex.asciidoc b/docs/reference/docs/reindex.asciidoc index dc27e40ecd90..26e4d1ab67c5 100644 --- a/docs/reference/docs/reindex.asciidoc +++ b/docs/reference/docs/reindex.asciidoc @@ -4,6 +4,12 @@ Reindex ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-document[Document APIs]. +-- + Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination diff --git a/docs/reference/docs/termvectors.asciidoc b/docs/reference/docs/termvectors.asciidoc index 31dfba1ac266..285db46fd4d2 100644 --- a/docs/reference/docs/termvectors.asciidoc +++ b/docs/reference/docs/termvectors.asciidoc @@ -4,6 +4,12 @@ Term vectors ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-document[Document APIs]. +-- + Retrieves information and statistics for terms in the fields of a particular document. [source,console] diff --git a/docs/reference/docs/update-by-query.asciidoc b/docs/reference/docs/update-by-query.asciidoc index d470080fc602..c5fccc86a1cc 100644 --- a/docs/reference/docs/update-by-query.asciidoc +++ b/docs/reference/docs/update-by-query.asciidoc @@ -4,6 +4,12 @@ Update by query ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-document[Document APIs]. +-- + Updates documents that match the specified query. If no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes. diff --git a/docs/reference/docs/update.asciidoc b/docs/reference/docs/update.asciidoc index a212c4e152b0..619cc921c4d6 100644 --- a/docs/reference/docs/update.asciidoc +++ b/docs/reference/docs/update.asciidoc @@ -4,6 +4,12 @@ Update ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-document[Document APIs]. +-- + Updates a document using the specified script. [[docs-update-api-request]] diff --git a/docs/reference/eql/delete-async-eql-search-api.asciidoc b/docs/reference/eql/delete-async-eql-search-api.asciidoc index 2f52a1a9cb23..f3c516188c25 100644 --- a/docs/reference/eql/delete-async-eql-search-api.asciidoc +++ b/docs/reference/eql/delete-async-eql-search-api.asciidoc @@ -6,6 +6,12 @@ Delete async EQL search ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-eql[EQL APIs]. +-- + Deletes an <> or a <>. The API also deletes results for the search. diff --git a/docs/reference/eql/eql-apis.asciidoc b/docs/reference/eql/eql-apis.asciidoc index e8cc2b21492a..0bf7462d8f4d 100644 --- a/docs/reference/eql/eql-apis.asciidoc +++ b/docs/reference/eql/eql-apis.asciidoc @@ -1,6 +1,12 @@ [[eql-apis]] == EQL APIs +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-eql[EQL APIs]. +-- + <> is a query language for event-based time series data, such as logs, metrics, and traces. For an overview of EQL and related tutorials, see <>. diff --git a/docs/reference/eql/eql-search-api.asciidoc b/docs/reference/eql/eql-search-api.asciidoc index d7f10f4627f6..97da43a6775b 100644 --- a/docs/reference/eql/eql-search-api.asciidoc +++ b/docs/reference/eql/eql-search-api.asciidoc @@ -6,6 +6,12 @@ EQL search ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-eql[EQL APIs]. +-- + Returns search results for an <> query. EQL assumes each document in a data stream or index corresponds to an diff --git a/docs/reference/eql/get-async-eql-search-api.asciidoc b/docs/reference/eql/get-async-eql-search-api.asciidoc index 2ac4271b5b98..36f18a7061bc 100644 --- a/docs/reference/eql/get-async-eql-search-api.asciidoc +++ b/docs/reference/eql/get-async-eql-search-api.asciidoc @@ -6,6 +6,12 @@ Get async EQL search ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-eql[EQL APIs]. +-- + Returns the current status and available results for an <> or a <>. diff --git a/docs/reference/eql/get-async-eql-status-api.asciidoc b/docs/reference/eql/get-async-eql-status-api.asciidoc index 908a65773f6a..fe188ec9112e 100644 --- a/docs/reference/eql/get-async-eql-status-api.asciidoc +++ b/docs/reference/eql/get-async-eql-status-api.asciidoc @@ -5,6 +5,13 @@ ++++ Get async EQL search status ++++ + +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-eql[EQL APIs]. +-- + Returns the current status for an <> or a <> without returning results. This is a more lightweight API than diff --git a/docs/reference/esql/esql-apis.asciidoc b/docs/reference/esql/esql-apis.asciidoc index 8586cd1ae6bc..57747d3e357e 100644 --- a/docs/reference/esql/esql-apis.asciidoc +++ b/docs/reference/esql/esql-apis.asciidoc @@ -1,6 +1,14 @@ [[esql-apis]] == {esql} APIs +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-esql[ES|QL APIs]. +-- + +https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-query + The <> provides a powerful way to filter, transform, and analyze data stored in {es}, and in the future in other runtimes. For an overview of {esql} and related tutorials, see <>. diff --git a/docs/reference/esql/esql-async-query-api.asciidoc b/docs/reference/esql/esql-async-query-api.asciidoc index 6cd23fc524f9..76597822a3fa 100644 --- a/docs/reference/esql/esql-async-query-api.asciidoc +++ b/docs/reference/esql/esql-async-query-api.asciidoc @@ -4,6 +4,12 @@ {esql} async query API ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-esql[ES|QL APIs]. +-- + Runs an async <>. The async query API lets you asynchronously execute a query request, diff --git a/docs/reference/esql/esql-async-query-delete-api.asciidoc b/docs/reference/esql/esql-async-query-delete-api.asciidoc index 5cad566f7f9c..a3f21ad81e44 100644 --- a/docs/reference/esql/esql-async-query-delete-api.asciidoc +++ b/docs/reference/esql/esql-async-query-delete-api.asciidoc @@ -4,6 +4,12 @@ {esql} async query delete API ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-esql[ES|QL APIs]. +-- + The <> async query delete API is used to manually delete an async query by ID. If the query is still running, the query will be cancelled. Otherwise, the stored results are deleted. diff --git a/docs/reference/esql/esql-async-query-get-api.asciidoc b/docs/reference/esql/esql-async-query-get-api.asciidoc index ec68313b2c49..c7ba3b2ce53e 100644 --- a/docs/reference/esql/esql-async-query-get-api.asciidoc +++ b/docs/reference/esql/esql-async-query-get-api.asciidoc @@ -4,6 +4,12 @@ {esql} async query get API ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-esql[ES|QL APIs]. +-- + Returns the current status and available results for an <> or a stored results. diff --git a/docs/reference/esql/esql-query-api.asciidoc b/docs/reference/esql/esql-query-api.asciidoc index d1809e519635..88fae50fae4b 100644 --- a/docs/reference/esql/esql-query-api.asciidoc +++ b/docs/reference/esql/esql-query-api.asciidoc @@ -4,6 +4,12 @@ {esql} query API ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-esql[ES|QL APIs]. +-- + Returns search results for an <> query. [source,console] diff --git a/docs/reference/features/apis/features-apis.asciidoc b/docs/reference/features/apis/features-apis.asciidoc index fe06471cff0d..94055a0a41d7 100644 --- a/docs/reference/features/apis/features-apis.asciidoc +++ b/docs/reference/features/apis/features-apis.asciidoc @@ -1,6 +1,12 @@ [[features-apis]] == Features APIs +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-features[Features APIs]. +-- + You can use the following APIs to introspect and manage Features provided by Elasticsearch and Elasticsearch plugins. diff --git a/docs/reference/features/apis/get-features-api.asciidoc b/docs/reference/features/apis/get-features-api.asciidoc index 676ec3c41da2..3df7ccb53689 100644 --- a/docs/reference/features/apis/get-features-api.asciidoc +++ b/docs/reference/features/apis/get-features-api.asciidoc @@ -4,6 +4,12 @@ Get features ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-features[Features APIs]. +-- + Gets a list of features which can be included in snapshots using the <> when creating a snapshot. diff --git a/docs/reference/features/apis/reset-features-api.asciidoc b/docs/reference/features/apis/reset-features-api.asciidoc index 36ff12cf0fc3..5223315caa56 100644 --- a/docs/reference/features/apis/reset-features-api.asciidoc +++ b/docs/reference/features/apis/reset-features-api.asciidoc @@ -6,6 +6,12 @@ experimental::[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-features[Features APIs]. +-- + Clears all of the state information stored in system indices by {es} features, including the security and machine learning indices. WARNING: Intended for development and testing use only. Do not reset features on a production cluster. diff --git a/docs/reference/fleet/fleet-multi-search.asciidoc b/docs/reference/fleet/fleet-multi-search.asciidoc index 3ee6b67b06ba..eaec76ebdd83 100644 --- a/docs/reference/fleet/fleet-multi-search.asciidoc +++ b/docs/reference/fleet/fleet-multi-search.asciidoc @@ -5,6 +5,12 @@ Fleet multi search ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-fleet[{fleet} APIs]. +-- + Executes several <> with a single API request. The API follows the same structure as the <> API. However, diff --git a/docs/reference/fleet/fleet-search.asciidoc b/docs/reference/fleet/fleet-search.asciidoc index 961846385969..10e77d9e6652 100644 --- a/docs/reference/fleet/fleet-search.asciidoc +++ b/docs/reference/fleet/fleet-search.asciidoc @@ -5,6 +5,12 @@ Fleet search ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-fleet[{fleet} APIs]. +-- + The purpose of the fleet search api is to provide a search api where the search will only be executed after provided checkpoint has been processed and is visible for searches inside of Elasticsearch. diff --git a/docs/reference/fleet/index.asciidoc b/docs/reference/fleet/index.asciidoc index b22609aff32e..bdffee227029 100644 --- a/docs/reference/fleet/index.asciidoc +++ b/docs/reference/fleet/index.asciidoc @@ -2,6 +2,12 @@ [[fleet-apis]] == Fleet APIs +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-fleet[{fleet} APIs]. +-- + TIP: For the {kib} {fleet} APIs, see the {fleet-guide}/fleet-api-docs.html[Fleet API Documentation]. diff --git a/docs/reference/graph/explore.asciidoc b/docs/reference/graph/explore.asciidoc index 34ac367125ad..1f5faeda76ef 100644 --- a/docs/reference/graph/explore.asciidoc +++ b/docs/reference/graph/explore.asciidoc @@ -2,6 +2,12 @@ [[graph-explore-api]] == Graph explore API +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-graph[Graph explore APIs]. +-- + The graph explore API enables you to extract and summarize information about the documents and terms in an {es} data stream or index. diff --git a/docs/reference/health/health.asciidoc b/docs/reference/health/health.asciidoc index 34714e80e1b1..7077cb28f894 100644 --- a/docs/reference/health/health.asciidoc +++ b/docs/reference/health/health.asciidoc @@ -4,6 +4,12 @@ Health ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-health_report[Cluster health APIs]. +-- + An API that reports the health status of an {es} cluster. [[health-api-request]] diff --git a/docs/reference/ilm/apis/ilm-api.asciidoc b/docs/reference/ilm/apis/ilm-api.asciidoc index 149ba2a6b449..3a6c8430bb4c 100644 --- a/docs/reference/ilm/apis/ilm-api.asciidoc +++ b/docs/reference/ilm/apis/ilm-api.asciidoc @@ -1,6 +1,13 @@ [[index-lifecycle-management-api]] == {ilm-cap} APIs +[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/indices.asciidoc b/docs/reference/indices.asciidoc index eaef54a1effb..ca7de396147a 100644 --- a/docs/reference/indices.asciidoc +++ b/docs/reference/indices.asciidoc @@ -1,6 +1,12 @@ [[indices]] == Index APIs +.New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Index APIs are used to manage individual indices, index settings, aliases, mappings, and index templates. diff --git a/docs/reference/indices/add-alias.asciidoc b/docs/reference/indices/add-alias.asciidoc index e14af6a64a2e..b8f6362f974c 100644 --- a/docs/reference/indices/add-alias.asciidoc +++ b/docs/reference/indices/add-alias.asciidoc @@ -4,6 +4,12 @@ Create or update alias ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Adds a data stream or index to an <>. [source,console] diff --git a/docs/reference/indices/alias-exists.asciidoc b/docs/reference/indices/alias-exists.asciidoc index f820a95028a0..5a43b10568d5 100644 --- a/docs/reference/indices/alias-exists.asciidoc +++ b/docs/reference/indices/alias-exists.asciidoc @@ -4,6 +4,12 @@ Alias exists ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Checks if an <> exists. [source,console] diff --git a/docs/reference/indices/aliases.asciidoc b/docs/reference/indices/aliases.asciidoc index 1df9e0a4883b..cff331d88af9 100644 --- a/docs/reference/indices/aliases.asciidoc +++ b/docs/reference/indices/aliases.asciidoc @@ -4,6 +4,12 @@ Aliases ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Performs one or more <> actions in a single atomic operation. [source,console] diff --git a/docs/reference/indices/analyze.asciidoc b/docs/reference/indices/analyze.asciidoc index eb4d877b463c..49e1c9de749f 100644 --- a/docs/reference/indices/analyze.asciidoc +++ b/docs/reference/indices/analyze.asciidoc @@ -4,6 +4,12 @@ Analyze ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Performs <> on a text string and returns the resulting tokens. diff --git a/docs/reference/indices/apis/unfreeze.asciidoc b/docs/reference/indices/apis/unfreeze.asciidoc index 450efc03c492..ece1f37c7784 100644 --- a/docs/reference/indices/apis/unfreeze.asciidoc +++ b/docs/reference/indices/apis/unfreeze.asciidoc @@ -17,6 +17,12 @@ 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 +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Unfreezes an index. [[unfreeze-index-api-request]] diff --git a/docs/reference/indices/clearcache.asciidoc b/docs/reference/indices/clearcache.asciidoc index a3150ec6f72e..19b2d204356a 100644 --- a/docs/reference/indices/clearcache.asciidoc +++ b/docs/reference/indices/clearcache.asciidoc @@ -4,6 +4,12 @@ Clear cache ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Clears the caches of one or more indices. For data streams, the API clears the caches of the stream's backing indices. diff --git a/docs/reference/indices/clone-index.asciidoc b/docs/reference/indices/clone-index.asciidoc index c8e5d2e200f2..192cf7035b84 100644 --- a/docs/reference/indices/clone-index.asciidoc +++ b/docs/reference/indices/clone-index.asciidoc @@ -4,6 +4,12 @@ Clone index ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Clones an existing index. [source,console] diff --git a/docs/reference/indices/close.asciidoc b/docs/reference/indices/close.asciidoc index a4bf1742fdea..a3014f811a1b 100644 --- a/docs/reference/indices/close.asciidoc +++ b/docs/reference/indices/close.asciidoc @@ -4,6 +4,12 @@ Close index ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Closes an index. [source,console] diff --git a/docs/reference/indices/create-data-stream.asciidoc b/docs/reference/indices/create-data-stream.asciidoc index e97e9973f106..278670047d4c 100644 --- a/docs/reference/indices/create-data-stream.asciidoc +++ b/docs/reference/indices/create-data-stream.asciidoc @@ -5,6 +5,12 @@ Create data stream ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. +-- + Creates a new <>. //// diff --git a/docs/reference/indices/create-index.asciidoc b/docs/reference/indices/create-index.asciidoc index 2e66f3d6030c..9a3934efa718 100644 --- a/docs/reference/indices/create-index.asciidoc +++ b/docs/reference/indices/create-index.asciidoc @@ -4,6 +4,12 @@ Create index ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Creates a new index. [source,console] diff --git a/docs/reference/indices/dangling-index-delete.asciidoc b/docs/reference/indices/dangling-index-delete.asciidoc index 6af35031e9e6..0afe9e0204bc 100644 --- a/docs/reference/indices/dangling-index-delete.asciidoc +++ b/docs/reference/indices/dangling-index-delete.asciidoc @@ -4,6 +4,12 @@ Delete dangling index ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Deletes a dangling index. [[dangling-index-delete-api-request]] diff --git a/docs/reference/indices/dangling-index-import.asciidoc b/docs/reference/indices/dangling-index-import.asciidoc index 44cde56de8c9..2b5922a2c0cf 100644 --- a/docs/reference/indices/dangling-index-import.asciidoc +++ b/docs/reference/indices/dangling-index-import.asciidoc @@ -4,6 +4,12 @@ Import dangling index ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Imports a dangling index. [[dangling-index-import-api-request]] diff --git a/docs/reference/indices/dangling-indices-list.asciidoc b/docs/reference/indices/dangling-indices-list.asciidoc index b7774843e36d..b098cb696e5f 100644 --- a/docs/reference/indices/dangling-indices-list.asciidoc +++ b/docs/reference/indices/dangling-indices-list.asciidoc @@ -4,6 +4,12 @@ List dangling indices ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Lists dangling indices. [[dangling-indices-list-api-request]] diff --git a/docs/reference/indices/data-stream-stats.asciidoc b/docs/reference/indices/data-stream-stats.asciidoc index 3ed285abc035..1d664e85628e 100644 --- a/docs/reference/indices/data-stream-stats.asciidoc +++ b/docs/reference/indices/data-stream-stats.asciidoc @@ -5,6 +5,12 @@ Data stream stats ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. +-- + Retrieves statistics for one or more <>. //// diff --git a/docs/reference/indices/delete-alias.asciidoc b/docs/reference/indices/delete-alias.asciidoc index 748862df0610..5a8baa262d99 100644 --- a/docs/reference/indices/delete-alias.asciidoc +++ b/docs/reference/indices/delete-alias.asciidoc @@ -4,6 +4,12 @@ Delete alias ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Removes a data stream or index from an <>. [source,console] diff --git a/docs/reference/indices/delete-component-template.asciidoc b/docs/reference/indices/delete-component-template.asciidoc index 065a4adb9002..0affd9e4d424 100644 --- a/docs/reference/indices/delete-component-template.asciidoc +++ b/docs/reference/indices/delete-component-template.asciidoc @@ -4,6 +4,12 @@ Delete component template ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Deletes an existing component template. //// diff --git a/docs/reference/indices/delete-data-stream.asciidoc b/docs/reference/indices/delete-data-stream.asciidoc index 38e7a00d451d..b8339624c837 100644 --- a/docs/reference/indices/delete-data-stream.asciidoc +++ b/docs/reference/indices/delete-data-stream.asciidoc @@ -5,6 +5,12 @@ Delete data stream ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. +-- + Deletes one or more <> and their backing indices. See <>. diff --git a/docs/reference/indices/delete-index-template-v1.asciidoc b/docs/reference/indices/delete-index-template-v1.asciidoc index 98b1e2fb255f..e8d5e2e355a5 100644 --- a/docs/reference/indices/delete-index-template-v1.asciidoc +++ b/docs/reference/indices/delete-index-template-v1.asciidoc @@ -9,6 +9,12 @@ 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 +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Deletes a legacy index template. //// diff --git a/docs/reference/indices/delete-index-template.asciidoc b/docs/reference/indices/delete-index-template.asciidoc index b828e4a536b7..430a18470da4 100644 --- a/docs/reference/indices/delete-index-template.asciidoc +++ b/docs/reference/indices/delete-index-template.asciidoc @@ -4,6 +4,12 @@ Delete index template ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Deletes an <>. //// diff --git a/docs/reference/indices/delete-index.asciidoc b/docs/reference/indices/delete-index.asciidoc index d5d168154e44..ec147fb10ff3 100644 --- a/docs/reference/indices/delete-index.asciidoc +++ b/docs/reference/indices/delete-index.asciidoc @@ -4,6 +4,12 @@ Delete index ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Deletes one or more indices. [source,console] diff --git a/docs/reference/indices/diskusage.asciidoc b/docs/reference/indices/diskusage.asciidoc index 3510ba346e5a..85d84ea9ad43 100644 --- a/docs/reference/indices/diskusage.asciidoc +++ b/docs/reference/indices/diskusage.asciidoc @@ -6,6 +6,12 @@ experimental[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Analyzes the disk usage of each field of an index or data stream. This API might not support indices created in previous {es} versions. The result of a small index can be inaccurate as some parts of an index diff --git a/docs/reference/indices/downsample-data-stream.asciidoc b/docs/reference/indices/downsample-data-stream.asciidoc index 5ace4e03dfb6..ecff35033e2d 100644 --- a/docs/reference/indices/downsample-data-stream.asciidoc +++ b/docs/reference/indices/downsample-data-stream.asciidoc @@ -5,6 +5,12 @@ Downsample ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. +-- + Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval. For example, diff --git a/docs/reference/indices/field-usage-stats.asciidoc b/docs/reference/indices/field-usage-stats.asciidoc index a4856092834e..f50c97ceddf0 100644 --- a/docs/reference/indices/field-usage-stats.asciidoc +++ b/docs/reference/indices/field-usage-stats.asciidoc @@ -6,6 +6,12 @@ experimental[] +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Returns field usage information for each shard and field of an index. Field usage statistics are automatically captured when diff --git a/docs/reference/indices/flush.asciidoc b/docs/reference/indices/flush.asciidoc index 61c44f157da9..03fd2c175ba5 100644 --- a/docs/reference/indices/flush.asciidoc +++ b/docs/reference/indices/flush.asciidoc @@ -4,6 +4,12 @@ Flush ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Flushes one or more data streams or indices. [source,console] diff --git a/docs/reference/indices/forcemerge.asciidoc b/docs/reference/indices/forcemerge.asciidoc index 6eacaac5e7b2..000b6bfa97f6 100644 --- a/docs/reference/indices/forcemerge.asciidoc +++ b/docs/reference/indices/forcemerge.asciidoc @@ -4,6 +4,12 @@ Force merge ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Forces a <> on the shards of one or more indices. For data streams, the API forces a merge on the shards of the stream's backing indices. diff --git a/docs/reference/indices/get-alias.asciidoc b/docs/reference/indices/get-alias.asciidoc index 743aaf7aee17..f03a06fe3074 100644 --- a/docs/reference/indices/get-alias.asciidoc +++ b/docs/reference/indices/get-alias.asciidoc @@ -4,6 +4,12 @@ Get alias ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Retrieves information for one or more <>. [source,console] diff --git a/docs/reference/indices/get-component-template.asciidoc b/docs/reference/indices/get-component-template.asciidoc index f35192ca448d..c98606e23303 100644 --- a/docs/reference/indices/get-component-template.asciidoc +++ b/docs/reference/indices/get-component-template.asciidoc @@ -4,6 +4,12 @@ Get component template ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Retrieves information about one or more component templates. ////////////////////////// diff --git a/docs/reference/indices/get-data-stream.asciidoc b/docs/reference/indices/get-data-stream.asciidoc index 6bf150897aca..88f136d0726f 100644 --- a/docs/reference/indices/get-data-stream.asciidoc +++ b/docs/reference/indices/get-data-stream.asciidoc @@ -5,6 +5,12 @@ Get data stream ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. +-- + Retrieves information about one or more <>. See <>. diff --git a/docs/reference/indices/get-field-mapping.asciidoc b/docs/reference/indices/get-field-mapping.asciidoc index ac5895872fbb..aac0ae9801f4 100644 --- a/docs/reference/indices/get-field-mapping.asciidoc +++ b/docs/reference/indices/get-field-mapping.asciidoc @@ -4,6 +4,12 @@ Get field mapping ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Retrieves <> for one or more fields. For data streams, the API retrieves field mappings for the stream's backing indices. diff --git a/docs/reference/indices/get-index-template-v1.asciidoc b/docs/reference/indices/get-index-template-v1.asciidoc index 602ca2fe454a..03f7e2873903 100644 --- a/docs/reference/indices/get-index-template-v1.asciidoc +++ b/docs/reference/indices/get-index-template-v1.asciidoc @@ -8,6 +8,12 @@ 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 +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Retrieves information about one or more index templates. //// diff --git a/docs/reference/indices/get-index-template.asciidoc b/docs/reference/indices/get-index-template.asciidoc index 2cde5adc8ae2..a1fb974b2bab 100644 --- a/docs/reference/indices/get-index-template.asciidoc +++ b/docs/reference/indices/get-index-template.asciidoc @@ -4,6 +4,12 @@ Get index template ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Returns information about one or more index templates. //// diff --git a/docs/reference/indices/get-index.asciidoc b/docs/reference/indices/get-index.asciidoc index 2551d25801d7..691493e078c4 100644 --- a/docs/reference/indices/get-index.asciidoc +++ b/docs/reference/indices/get-index.asciidoc @@ -4,6 +4,12 @@ Get index ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Returns information about one or more indices. For data streams, the API returns information about the stream's backing indices. diff --git a/docs/reference/indices/get-mapping.asciidoc b/docs/reference/indices/get-mapping.asciidoc index 16dc8c66d071..9fd02e6fba89 100644 --- a/docs/reference/indices/get-mapping.asciidoc +++ b/docs/reference/indices/get-mapping.asciidoc @@ -4,6 +4,12 @@ Get mapping ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Retrieves <> for one or more indices. For data streams, the API retrieves mappings for the stream's backing indices. diff --git a/docs/reference/indices/get-settings.asciidoc b/docs/reference/indices/get-settings.asciidoc index b6cb6d292638..4b3929664bf1 100644 --- a/docs/reference/indices/get-settings.asciidoc +++ b/docs/reference/indices/get-settings.asciidoc @@ -4,6 +4,12 @@ Get index settings ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Returns setting information for one or more indices. For data streams, the API returns setting information for the stream's backing indices. diff --git a/docs/reference/indices/index-template-exists-v1.asciidoc b/docs/reference/indices/index-template-exists-v1.asciidoc index 2358f0b1a376..d9aec6f4b86c 100644 --- a/docs/reference/indices/index-template-exists-v1.asciidoc +++ b/docs/reference/indices/index-template-exists-v1.asciidoc @@ -9,6 +9,12 @@ 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 +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Checks if an <> exists. diff --git a/docs/reference/indices/indices-exists.asciidoc b/docs/reference/indices/indices-exists.asciidoc index d699d36add03..3594619c22fc 100644 --- a/docs/reference/indices/indices-exists.asciidoc +++ b/docs/reference/indices/indices-exists.asciidoc @@ -4,6 +4,12 @@ Exists ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Checks if a data stream, index, or alias exists. [source,console] diff --git a/docs/reference/indices/migrate-to-data-stream.asciidoc b/docs/reference/indices/migrate-to-data-stream.asciidoc index 48302761c7dc..8c5a8d7b1376 100644 --- a/docs/reference/indices/migrate-to-data-stream.asciidoc +++ b/docs/reference/indices/migrate-to-data-stream.asciidoc @@ -5,6 +5,12 @@ Migrate to data stream ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-data-stream[Data stream APIs]. +-- + Converts an <> to a <>. //// diff --git a/docs/reference/indices/open-close.asciidoc b/docs/reference/indices/open-close.asciidoc index a077c4d19fd5..e9502b3f8328 100644 --- a/docs/reference/indices/open-close.asciidoc +++ b/docs/reference/indices/open-close.asciidoc @@ -4,6 +4,12 @@ Open index ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Opens a closed index. For data streams, the API opens any closed backing indices. diff --git a/docs/reference/indices/put-component-template.asciidoc b/docs/reference/indices/put-component-template.asciidoc index 05579d46d676..c2a75c80b9c3 100644 --- a/docs/reference/indices/put-component-template.asciidoc +++ b/docs/reference/indices/put-component-template.asciidoc @@ -4,6 +4,12 @@ Create or update component template ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Creates or updates a component template. Component templates are building blocks for constructing <> that specify index <>, <>, and diff --git a/docs/reference/indices/put-index-template-v1.asciidoc b/docs/reference/indices/put-index-template-v1.asciidoc index 75325edf7769..24e9835960f9 100644 --- a/docs/reference/indices/put-index-template-v1.asciidoc +++ b/docs/reference/indices/put-index-template-v1.asciidoc @@ -8,6 +8,12 @@ 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 +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Creates or updates an index template. [source,console] diff --git a/docs/reference/indices/put-index-template.asciidoc b/docs/reference/indices/put-index-template.asciidoc index 9a3103754679..17035daeca15 100644 --- a/docs/reference/indices/put-index-template.asciidoc +++ b/docs/reference/indices/put-index-template.asciidoc @@ -4,6 +4,12 @@ Create or update index template ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Creates or updates an index template. Index templates define <>, <>, and <> that can be applied automatically to new indices. diff --git a/docs/reference/indices/put-mapping.asciidoc b/docs/reference/indices/put-mapping.asciidoc index dc6dbff1df42..acd5df00cb77 100644 --- a/docs/reference/indices/put-mapping.asciidoc +++ b/docs/reference/indices/put-mapping.asciidoc @@ -4,6 +4,12 @@ Update mapping ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Adds new fields to an existing data stream or index. You can also use this API to change the search settings of existing fields. diff --git a/docs/reference/indices/recovery.asciidoc b/docs/reference/indices/recovery.asciidoc index 06b4d9d92e49..44094eea73f6 100644 --- a/docs/reference/indices/recovery.asciidoc +++ b/docs/reference/indices/recovery.asciidoc @@ -4,6 +4,12 @@ Index recovery ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Returns information about ongoing and completed shard recoveries for one or more indices. For data streams, the API returns information for the stream's backing indices. diff --git a/docs/reference/indices/refresh.asciidoc b/docs/reference/indices/refresh.asciidoc index bd8e821ff56b..60774ffd6400 100644 --- a/docs/reference/indices/refresh.asciidoc +++ b/docs/reference/indices/refresh.asciidoc @@ -4,6 +4,12 @@ Refresh ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream's backing indices. For more information about the refresh operation, see diff --git a/docs/reference/indices/resolve-cluster.asciidoc b/docs/reference/indices/resolve-cluster.asciidoc index 48e6bfac4af1..fc0301916e68 100644 --- a/docs/reference/indices/resolve-cluster.asciidoc +++ b/docs/reference/indices/resolve-cluster.asciidoc @@ -4,6 +4,12 @@ Resolve cluster ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Resolves the specified index expressions to return information about each cluster, including the local cluster, if included. diff --git a/docs/reference/indices/resolve.asciidoc b/docs/reference/indices/resolve.asciidoc index 856546b037fe..fb6c97d9ecf4 100644 --- a/docs/reference/indices/resolve.asciidoc +++ b/docs/reference/indices/resolve.asciidoc @@ -4,6 +4,12 @@ Resolve index ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported. diff --git a/docs/reference/indices/rollover-index.asciidoc b/docs/reference/indices/rollover-index.asciidoc index 2a47d28e5358..b15444977ba8 100644 --- a/docs/reference/indices/rollover-index.asciidoc +++ b/docs/reference/indices/rollover-index.asciidoc @@ -4,6 +4,12 @@ Rollover ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Creates a new index for a <> or <>. [source,console] diff --git a/docs/reference/indices/segments.asciidoc b/docs/reference/indices/segments.asciidoc index 54f0b6c0cd6d..df999ec4c897 100644 --- a/docs/reference/indices/segments.asciidoc +++ b/docs/reference/indices/segments.asciidoc @@ -4,6 +4,12 @@ Index segments ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Returns low-level information about the https://lucene.apache.org/core/[Lucene] segments in index shards. For data streams, the API returns information about the stream's backing indices. diff --git a/docs/reference/indices/shard-stores.asciidoc b/docs/reference/indices/shard-stores.asciidoc index 1b001a3175b8..b6f2aca78be0 100644 --- a/docs/reference/indices/shard-stores.asciidoc +++ b/docs/reference/indices/shard-stores.asciidoc @@ -4,6 +4,12 @@ Index shard stores ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Retrieves store information about replica shards in one or more indices. For data streams, the API retrieves store diff --git a/docs/reference/indices/shrink-index.asciidoc b/docs/reference/indices/shrink-index.asciidoc index 244733282d46..1f4e849abff1 100644 --- a/docs/reference/indices/shrink-index.asciidoc +++ b/docs/reference/indices/shrink-index.asciidoc @@ -4,6 +4,12 @@ Shrink index ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Shrinks an existing index into a new index with fewer primary shards. diff --git a/docs/reference/indices/simulate-index.asciidoc b/docs/reference/indices/simulate-index.asciidoc index 5e5709a2d82f..598e4a12acb2 100644 --- a/docs/reference/indices/simulate-index.asciidoc +++ b/docs/reference/indices/simulate-index.asciidoc @@ -4,6 +4,12 @@ Simulate index ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Returns the index configuration that would be applied to the specified index from an existing <>. diff --git a/docs/reference/indices/simulate-template.asciidoc b/docs/reference/indices/simulate-template.asciidoc index fd825883dc20..57f4dd6d4ff2 100644 --- a/docs/reference/indices/simulate-template.asciidoc +++ b/docs/reference/indices/simulate-template.asciidoc @@ -4,6 +4,12 @@ Simulate template ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Returns the index configuration that would be applied by a particular <>. diff --git a/docs/reference/indices/split-index.asciidoc b/docs/reference/indices/split-index.asciidoc index 0c93b572639d..a4ee3faa9dc2 100644 --- a/docs/reference/indices/split-index.asciidoc +++ b/docs/reference/indices/split-index.asciidoc @@ -4,6 +4,12 @@ Split index ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Splits an existing index into a new index with more primary shards. [source,console] diff --git a/docs/reference/indices/stats.asciidoc b/docs/reference/indices/stats.asciidoc index 088d65c37ec6..486b13e47827 100644 --- a/docs/reference/indices/stats.asciidoc +++ b/docs/reference/indices/stats.asciidoc @@ -4,6 +4,12 @@ Index stats ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Returns statistics for one or more indices. For data streams, the API retrieves statistics for the stream's backing indices. diff --git a/docs/reference/indices/update-settings.asciidoc b/docs/reference/indices/update-settings.asciidoc index 3b29946d5ed7..ad500943a042 100644 --- a/docs/reference/indices/update-settings.asciidoc +++ b/docs/reference/indices/update-settings.asciidoc @@ -4,6 +4,12 @@ Update index settings ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[Index APIs]. +-- + Changes a <> in real time. For data streams, index setting changes are applied to all backing indices by diff --git a/docs/reference/ingest/apis/enrich/delete-enrich-policy.asciidoc b/docs/reference/ingest/apis/enrich/delete-enrich-policy.asciidoc index 1d4b7e770325..d190322fbfe9 100644 --- a/docs/reference/ingest/apis/enrich/delete-enrich-policy.asciidoc +++ b/docs/reference/ingest/apis/enrich/delete-enrich-policy.asciidoc @@ -5,6 +5,12 @@ Delete enrich policy ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-enrich[Enrich APIs]. +-- + Deletes an existing <> and its <>. diff --git a/docs/reference/ingest/apis/enrich/execute-enrich-policy.asciidoc b/docs/reference/ingest/apis/enrich/execute-enrich-policy.asciidoc index ebad9f09250d..312cb2593f1f 100644 --- a/docs/reference/ingest/apis/enrich/execute-enrich-policy.asciidoc +++ b/docs/reference/ingest/apis/enrich/execute-enrich-policy.asciidoc @@ -5,6 +5,12 @@ Execute enrich policy ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-enrich[Enrich APIs]. +-- + Executes an existing <>. //// diff --git a/docs/reference/ingest/apis/enrich/get-enrich-policy.asciidoc b/docs/reference/ingest/apis/enrich/get-enrich-policy.asciidoc index 88cf2cfa7cf6..48448f592504 100644 --- a/docs/reference/ingest/apis/enrich/get-enrich-policy.asciidoc +++ b/docs/reference/ingest/apis/enrich/get-enrich-policy.asciidoc @@ -5,6 +5,12 @@ Get enrich policy ++++ +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-enrich[Enrich APIs]. +-- + Returns information about an <>. //// diff --git a/docs/reference/ingest/apis/enrich/index.asciidoc b/docs/reference/ingest/apis/enrich/index.asciidoc index a17c8179af1b..0488d535000e 100644 --- a/docs/reference/ingest/apis/enrich/index.asciidoc +++ b/docs/reference/ingest/apis/enrich/index.asciidoc @@ -2,6 +2,12 @@ [[enrich-apis]] == Enrich APIs +..New API reference +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-enrich[Enrich APIs]. +-- + The following enrich APIs are available for managing <>: diff --git a/docs/reference/ingest/apis/enrich/put-enrich-policy.asciidoc b/docs/reference/ingest/apis/enrich/put-enrich-policy.asciidoc index ee33b0b32090..80223cb0ec71 100644 --- a/docs/reference/ingest/apis/enrich/put-enrich-policy.asciidoc +++ b/docs/reference/ingest/apis/enrich/put-enrich-policy.asciidoc @@ -5,6 +5,11 @@ Create enrich policy ++++ +[sidebar] +-- +For the most up-to-date API details, refer to {api-es}/group/endpoint-enrich[Enrich APIs]. +-- + Creates an enrich policy. //// diff --git a/docs/reference/rest-api/index.asciidoc b/docs/reference/rest-api/index.asciidoc index 50c9f96ad81b..bfab15ed012c 100644 --- a/docs/reference/rest-api/index.asciidoc +++ b/docs/reference/rest-api/index.asciidoc @@ -6,9 +6,9 @@ {es} exposes REST APIs that are used by the UI components and can be called directly to configure and access {es} features. -[NOTE] -We are working on including more {es} APIs in this section. Some content might -not be included yet. +..New API reference +[sidebar] +For the most up-to-date API details, refer to {api-es}[{es} APIs]. * <> * <>