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

« Get remote clusters for cross-cluster search Get cluster curation settings »

› › › ›

Set remote clusters for cross-cluster search

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Set remote clusters for cross-cluster search

edit

This endpoint is deprecated and scheduled to be removed in the next major version. Use set Elasticsearch remote clusters instead.

Overwrites or creates the cross-cluster search configuration for the Elasticsearch cluster.

Request

edit

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

Path parameters

edit

Name	Type	Required	Description
`cluster_id`	`string`	Y	Elasticsearch cluster identifier

Request body

edit

(CrossClusterSearchSettings) (required) Remote clusters for cross-cluster search

Responses

edit

202

(EmptyResponse)

The configuration for remote clusters was updated

404

(BasicFailedReply)

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

Request example

edit

curl -XPUT https://{{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/ccs/settings \
-H "Authorization: ApiKey $ECE_API_KEY" \
-d '
{
   "remote_clusters" : {
      "some_property" : {
         "cluster_id" : "string",
         "skip_unavailable" : true
      }
   }
}
'

« Get remote clusters for cross-cluster search Get cluster curation settings »