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.

« Get cross-cluster search clusters Set remote clusters for cross-cluster search »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.4] ›RESTful API ›API reference ›Clusters - Elasticsearch - CRUD - Configuration

Get remote clusters for cross-cluster search

edit

Get remote clusters for cross-cluster search

edit

Returns cross-cluster search configuration for the Elasticsearch cluster.

Request

edit

GET /api/v1/clusters/elasticsearch/{cluster_id}/ccs/settings

Path parameters

edit
Name Type Required Description

cluster_id

string

Y

Elasticsearch cluster identifier

Responses

edit
200

(CrossClusterSearchSettings) The configuration for cross-cluster search

404

(BasicFailedReply) The cluster specified by {cluster_id} or a remote cluster cannot be found (code: 'clusters.cluster_not_found')

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit
curl -XGET {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/ccs/settings \
-H "Authorization: ApiKey $ECE_API_KEY"
« Get cross-cluster search clusters Set remote clusters for cross-cluster search »