Deployment - Remote Clusters

Get remote clusters

Returns the list of remote clusters for the elasticsearch resource.

Request

GET /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters

Path parameters

Name Type Required Description

deployment_id

string

Y

Identifier for the Deployment.

ref_id

string

Y

User-specified RefId for the Resource.

Responses

200

(RemoteResources) List of remote clusters for the resource

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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XGET https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters \
-H "Authorization: ApiKey $EC_API_KEY"

Set remote clusters

Overwrites or creates the remote clusters for the elasticsearch resource.

Request

PUT /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters

Path parameters

Name Type Required Description

deployment_id

string

Y

Identifier for the Deployment.

ref_id

string

Y

User-specified RefId for the Resource.

Request body

(RemoteResources) (required) List of remote clusters for the resource

Responses

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

curl -XPUT https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters \
-H "Authorization: ApiKey $EC_API_KEY" \
-d '
{
   "resources" : [
      {
         "alias" : "string",
         "deployment_id" : "string",
         "elasticsearch_ref_id" : "string",
         "skip_unavailable" : true
      }
   ]
}
'