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
editSet 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
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the Deployment. |
|
|
Y |
User-specified RefId for the Resource. |
Request body
edit(RemoteResources
) (required) List of remote clusters for the resource
Responses
edit-
202
-
(
EmptyResponse
) The Remote Clusters were updated -
404
-
(
BasicFailedReply
) * 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
-
-
449
-
(
BasicFailedReply
) 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
-
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request example
editcurl -XPUT https://{{hostname}}/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters \ -H "Authorization: ApiKey $ECE_API_KEY" \ -d ' { "resources" : [ { "alias" : "string", "deployment_id" : "string", "elasticsearch_ref_id" : "string", "skip_unavailable" : true } ] } '