[DOCS] Link to new API site (#119038) (#119360)

Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
This commit is contained in:
Lisa Cawley 2024-12-30 09:18:27 -08:00 committed by GitHub
parent 1bdcb23479
commit f6a2a991d5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
199 changed files with 1193 additions and 8 deletions

View file

@ -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]

View file

@ -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]]

View file

@ -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]]

View file

@ -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]]

View file

@ -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]]

View file

@ -8,6 +8,12 @@ beta::[]
<titleabbrev>Delete Analytics Collection</titleabbrev>
++++
.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-analytics[Behavioral analytics APIs].
--
////
[source,console]
----

View file

@ -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 <<behavioral-analytics-overview,Behavioral Analytics>>:
* <<put-analytics-collection>>

View file

@ -8,6 +8,12 @@ beta::[]
<titleabbrev>List Analytics Collections</titleabbrev>
++++
.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-analytics[Behavioral analytics APIs].
--
////
[source,console]
----

View file

@ -8,6 +8,12 @@ beta::[]
<titleabbrev>Post Analytics Collection Event</titleabbrev>
++++
.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-analytics[Behavioral analytics APIs].
--
////
[source,console]
----

View file

@ -8,6 +8,12 @@ beta::[]
<titleabbrev>Put Analytics Collection</titleabbrev>
++++
.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-analytics[Behavioral analytics APIs].
--
////
[source,console]
----

View file

@ -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

View file

@ -4,6 +4,12 @@
<titleabbrev>cat aliases</titleabbrev>
++++
..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

View file

@ -4,6 +4,12 @@
<titleabbrev>cat allocation</titleabbrev>
++++
..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}

View file

@ -5,6 +5,12 @@
<titleabbrev>cat anomaly detectors</titleabbrev>
++++
..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}

View file

@ -4,6 +4,12 @@
<titleabbrev>cat component templates</titleabbrev>
++++
..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}

View file

@ -4,6 +4,12 @@
<titleabbrev>cat count</titleabbrev>
++++
..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}

View file

@ -5,6 +5,12 @@
<titleabbrev>cat {dfeeds}</titleabbrev>
++++
..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}

View file

@ -5,6 +5,12 @@
<titleabbrev>cat {dfanalytics}</titleabbrev>
++++
..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}

View file

@ -4,6 +4,12 @@
<titleabbrev>cat fielddata</titleabbrev>
++++
..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}

View file

@ -4,6 +4,12 @@
<titleabbrev>cat health</titleabbrev>
++++
..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}

View file

@ -4,6 +4,12 @@
<titleabbrev>cat indices</titleabbrev>
++++
..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}

View file

@ -4,6 +4,12 @@
<titleabbrev>cat master</titleabbrev>
++++
..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}

View file

@ -4,6 +4,12 @@
<titleabbrev>cat nodeattrs</titleabbrev>
++++
..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}

View file

@ -5,6 +5,12 @@
<titleabbrev>cat nodes</titleabbrev>
++++
..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}

View file

@ -4,6 +4,12 @@
<titleabbrev>cat pending tasks</titleabbrev>
++++
..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}

View file

@ -4,6 +4,11 @@
<titleabbrev>cat plugins</titleabbrev>
++++
..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]
====

View file

@ -4,6 +4,12 @@
<titleabbrev>cat recovery</titleabbrev>
++++
..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}

View file

@ -4,6 +4,12 @@
<titleabbrev>cat repositories</titleabbrev>
++++
..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}

View file

@ -4,6 +4,12 @@
<titleabbrev>cat segments</titleabbrev>
++++
..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}

View file

@ -5,6 +5,12 @@
<titleabbrev>cat shards</titleabbrev>
++++
..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}

View file

@ -4,6 +4,12 @@
<titleabbrev>cat snapshots</titleabbrev>
++++
..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}

View file

@ -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}

View file

@ -4,6 +4,12 @@
<titleabbrev>cat templates</titleabbrev>
++++
..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}

View file

@ -4,6 +4,12 @@
<titleabbrev>cat thread pool</titleabbrev>
++++
..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}

View file

@ -5,6 +5,12 @@
<titleabbrev>cat trained model</titleabbrev>
++++
..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}

View file

@ -5,6 +5,12 @@
<titleabbrev>cat transforms</titleabbrev>
++++
..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}

View file

@ -5,6 +5,12 @@
<titleabbrev>Delete auto-follow pattern</titleabbrev>
++++
..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-auto-follow,auto-follow patterns>>.
[[ccr-delete-auto-follow-pattern-request]]

View file

@ -5,6 +5,12 @@
<titleabbrev>Get auto-follow pattern</titleabbrev>
++++
..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-auto-follow,auto-follow patterns>>.
[[ccr-get-auto-follow-pattern-request]]

View file

@ -5,6 +5,12 @@
<titleabbrev>Pause auto-follow pattern</titleabbrev>
++++
..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-auto-follow,auto-follow pattern>>.
[[ccr-pause-auto-follow-pattern-request]]

View file

@ -5,6 +5,12 @@
<titleabbrev>Create auto-follow pattern</titleabbrev>
++++
..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-auto-follow,auto-follow pattern>>.
[[ccr-put-auto-follow-pattern-request]]

View file

@ -5,6 +5,12 @@
<titleabbrev>Resume auto-follow pattern</titleabbrev>
++++
..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-auto-follow,auto-follow pattern>>.
[[ccr-resume-auto-follow-pattern-request]]

View file

@ -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 <<xpack-ccr,{ccr}>> operations.
[discrete]

View file

@ -5,6 +5,12 @@
<titleabbrev>Get follower info</titleabbrev>
++++
..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 <<xpack-ccr,{ccr}>> follower indices.
[[ccr-get-follow-info-request]]

View file

@ -5,6 +5,12 @@
<titleabbrev>Get follower stats</titleabbrev>
++++
..New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs].
--
Get <<xpack-ccr,{ccr}>> follower stats.
[[ccr-get-follow-stats-request]]

View file

@ -5,6 +5,12 @@
<titleabbrev>Forget follower</titleabbrev>
++++
..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 <<xpack-ccr,{ccr}>> follower retention leases from the leader.
[[ccr-post-forget-follower-request]]

View file

@ -5,6 +5,12 @@
<titleabbrev>Pause follower</titleabbrev>
++++
..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 <<xpack-ccr,{ccr}>> follower index.
[[ccr-post-pause-follow-request]]

View file

@ -5,6 +5,12 @@
<titleabbrev>Resume follower</titleabbrev>
++++
..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 <<xpack-ccr,{ccr}>> follower index.
[[ccr-post-resume-follow-request]]

View file

@ -5,6 +5,12 @@
<titleabbrev>Unfollow</titleabbrev>
++++
..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 <<xpack-ccr,{ccr}>> follower index to a regular index.
[[ccr-post-unfollow-request]]

View file

@ -5,6 +5,12 @@
<titleabbrev>Create follower</titleabbrev>
++++
..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 <<xpack-ccr,{ccr}>> follower index.
[[ccr-put-follow-request]]

View file

@ -6,6 +6,12 @@
<titleabbrev>Get {ccr-init} stats</titleabbrev>
++++
..New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-ccr[Cross-cluster replication APIs].
--
Get <<xpack-ccr,{ccr}>> stats.
[[ccr-get-stats-request]]

View file

@ -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

View file

@ -4,6 +4,12 @@
<titleabbrev>Cluster allocation explain</titleabbrev>
++++
..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 <<index-modules-allocation,allocation>>.
[source,console]

View file

@ -7,6 +7,12 @@ experimental::[]
<titleabbrev>Cluster Info</titleabbrev>
++++
..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]]

View file

@ -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 <<shards-rebalancing-heuristics,desired balance>> 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

View file

@ -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]]

View file

@ -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 <<shards-rebalancing-heuristics,desired balance>> computation and reconciliation stats

View file

@ -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]]

View file

@ -4,6 +4,12 @@
<titleabbrev>Cluster get settings</titleabbrev>
++++
..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]

View file

@ -4,6 +4,12 @@
<titleabbrev>Cluster health</titleabbrev>
++++
..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]]

View file

@ -4,6 +4,12 @@
<titleabbrev>Nodes hot threads</titleabbrev>
++++
..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]]

View file

@ -4,8 +4,13 @@
<titleabbrev>Nodes info</titleabbrev>
++++
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}

View file

@ -4,6 +4,12 @@
<titleabbrev>Nodes reload secure settings</titleabbrev>
++++
..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]]

View file

@ -5,6 +5,12 @@
<titleabbrev>Nodes stats</titleabbrev>
++++
..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]]

View file

@ -4,8 +4,13 @@
<titleabbrev>Nodes feature usage</titleabbrev>
++++
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}

View file

@ -4,6 +4,12 @@
<titleabbrev>Pending cluster tasks</titleabbrev>
++++
..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.

View file

@ -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]]

View file

@ -4,8 +4,13 @@
<titleabbrev>Remote cluster info</titleabbrev>
++++
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}

View file

@ -4,8 +4,13 @@
<titleabbrev>Cluster reroute</titleabbrev>
++++
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}

View file

@ -4,6 +4,12 @@
<titleabbrev>Cluster state</titleabbrev>
++++
..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.

View file

@ -5,6 +5,12 @@
<titleabbrev>Cluster stats</titleabbrev>
++++
..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]]

View file

@ -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]]

View file

@ -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]]

View file

@ -4,8 +4,13 @@
<titleabbrev>Cluster update settings</titleabbrev>
++++
Configures <<dynamic-cluster-setting,dynamic cluster settings>>.
..New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs].
--
Configures <<dynamic-cluster-setting,dynamic cluster settings>>.
[[cluster-update-settings-api-request]]
==== {api-request-title}

View file

@ -4,6 +4,12 @@
<titleabbrev>Voting configuration exclusions</titleabbrev>
++++
..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
<<modules-discovery-voting,voting configuration exclusion list>>.

View file

@ -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 <<es-connectors-tutorial-api, our tutorial>>.

View file

@ -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 <<es-connectors-tutorial-api, our tutorial>>.

View file

@ -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 <<es-connectors-tutorial-api, our tutorial>>.

View file

@ -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}.

View file

@ -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 <<es-connectors,connectors>>.

View file

@ -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:

View file

@ -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.

View file

@ -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.

View file

@ -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.

View file

@ -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 <<es-connectors-tutorial-api, our tutorial>>.

View file

@ -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 <<es-connectors-tutorial-api, our tutorial>>.

View file

@ -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 <<es-connectors-tutorial-api, our tutorial>>.

View file

@ -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 <<es-connectors-tutorial-api, our tutorial>>.

View file

@ -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 <<es-connectors-tutorial-api, our tutorial>>.

View file

@ -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 <<es-connectors-tutorial-api, our tutorial>>.

View file

@ -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

View file

@ -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 <<es-connectors-tutorial-api, our tutorial>>.

View file

@ -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 <<es-connectors-tutorial-api, our tutorial>>.

View file

@ -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

View file

@ -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 <<es-sync-rules>>.

View file

@ -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 <<es-connectors-tutorial-api, our tutorial>>.

View file

@ -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.

View file

@ -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.

View file

@ -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 <<ingest-pipeline-search-details-generic-reference, ingest pipeline>> is populated with default settings.

View file

@ -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 <<es-connectors-tutorial-api, our tutorial>>.

View file

@ -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 <<es-connectors-tutorial-api, our tutorial>>.

Some files were not shown because too many files have changed in this diff Show more