A newer version is available. For the latest information, see the
current release documentation.
Set remote clusters
edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.
Set remote clusters
editOverwrites or creates the remote clusters for the elasticsearch resource.
Request
editPUT /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters
Path parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
Identifier for the Deployment. |
|
|
Y |
User-specified RefId for the Resource (or '_main' if there is only one). |
Request body
edit(RemoteResources) (required) List of remote clusters for the resource
Responses
edit-
202 -
The Remote Clusters were updated
-
404 -
-
The Deployment specified by {deployment_id} cannot be found. (code:
deployments.deployment_not_found) -
The Resource specified by {ref_id} cannot be found. (code:
deployments.deployment_resource_not_found)
Headers
-
x-cloud-error-codes(string; allowed values: [deployments.deployment_not_found,deployments.deployment_resource_not_found]) - The error codes associated with the response
-
The Deployment specified by {deployment_id} cannot be found. (code:
-
449 -
Elevated permissions are required. (code:
root.unauthorized.rbac.elevated_permissions_required)Headers
-
x-cloud-error-codes(string; allowed values: [root.unauthorized.rbac.elevated_permissions_required]) - The error codes associated with the response
-
Request example
editcurl -XPUT https://{{hostname}}/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
"resources" : [
{
"alias" : "string",
"deployment_id" : "string",
"elasticsearch_ref_id" : "string",
"info" : {
"compatible" : true,
"connected" : true,
"healthy" : true,
"trusted" : true,
"trusted_back" : true
},
"skip_unavailable" : true
}
]
}
'