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.
Set remote clusters for cross-cluster search
editSet remote clusters for cross-cluster search
editOverwrites or creates the cross-cluster search configuration for the Elasticsearch cluster.
Request
editPUT /api/v1/clusters/elasticsearch/{cluster_id}/ccs/settings
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
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 can't 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
editcurl -XPUT {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/ccs/settings \ -u $CLOUD_USER:$CLOUD_KEY \ -H 'Content-Type: application/json' \ -d ' { "remote_clusters" : { "some_property" : { "cluster_id" : "string", "skip_unavailable" : true } } } '