It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Search clusters that can be used as cross-cluster search remotesedit
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 -
(
ElasticsearchClustersInfo) A list of Elasticsearch clusters that can be used as cross-cluster search remotes in deployments with the provided version -
400 -
(
BasicFailedReply) The search request failed.
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
curl -XGET {{hostname}}/api/v1/clusters/elasticsearch/ccs/eligible_remotes \
-H "Authorization: ApiKey $ECE_API_KEY"