Search clusters that can be used as cross-cluster search remotesedit
This endpoint is deprecated and scheduled to be removed in the next major version. Use search eligible remote clusters instead.
Retrieves the information for all of the Elasticsearch clusters that can selected as remotes in a given version.
Requestedit
GET /api/v1/clusters/elasticsearch/ccs/eligible_remotes
Query parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
N |
(Optional) Returns only clusters filtered by the provided owner id. |
|
|
N |
(Optional) Cluster name or id prefix to filters the candidates. |
|
|
N |
(Optional) Maximum number of clusters to include in the response. |
|
|
Y |
The version of the cross-cluster search cluster that will link with the remote candidates. |
Responsesedit
-
200 -
A list of Elasticsearch clusters that can be used as cross-cluster search remotes in deployments with the provided version
-
400 -
The search request failed.
Request exampleedit
curl -XGET https://{{hostname}}/api/v1/clusters/elasticsearch/ccs/eligible_remotes \
-H "Authorization: ApiKey $ECE_API_KEY"