A newer version is available. For the latest information, see the
current release documentation.
Set remote clusters for cross-cluster searchedit
DEPRECATED (Scheduled to be removed in the next major version): Overwrites or creates the cross-cluster search configuration for the Elasticsearch cluster.
Requestedit
PUT /api/v1/clusters/elasticsearch/{cluster_id}/ccs/settings
Path parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
Elasticsearch cluster identifier |
Request bodyedit
(CrossClusterSearchSettings) (required) Remote clusters for cross-cluster search
Responsesedit
-
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')
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
curl -XPUT https://{{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/ccs/settings \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
"remote_clusters" : {
"some_property" : {
"cluster_id" : "string",
"skip_unavailable" : true
}
}
}
'