IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› › › ›

Search clusters that can be used as cross-cluster search remotes

edit

Search clusters that can be used as cross-cluster search remotes

edit

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.

Request

edit

GET /api/v1/clusters/elasticsearch/ccs/eligible_remotes

Query parameters

edit

Name	Type	Required	Description
`owner_id`	`string`	N	(Optional) Returns only clusters filtered by the provided owner id.
`q`	`string`	N	(Optional) Cluster name or id prefix to filters the candidates.
`size`	`integer`	N	(Optional) Maximum number of clusters to include in the response.
`version`	`string`	Y	The version of the cross-cluster search cluster that will link with the remote candidates.

Responses

edit

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.

Request example

edit

curl -XGET https://{{hostname}}/api/v1/clusters/elasticsearch/ccs/eligible_remotes \
-H "Authorization: ApiKey $ECE_API_KEY"

« Create cluster Delete cluster »