Set certificate based remote clusters

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

Overwrites or creates the list of certificate based remote clusters for the elasticsearch resource.

Path parameters

deployment_id string Required

Identifier for the Deployment.
ref_id string Required

User-specified RefId for the Resource (or '_main' if there is only one).

Body Required

The list of resources that will be configured as remote clusters

resources array[object] Required

The remote resources
Hide resources attributes Show resources attributes object
The Elasticsearch resource used as a Remote Cluster.
- deployment_id string Required
  
  The id of the deployment
- elasticsearch_ref_id string Required
  
  The locally-unique user-specified id of an Elasticsearch Resource
- alias string Required
  
  The alias for this remote cluster. Aliases must only contain letters, digits, dashes and underscores
- skip_unavailable boolean
  
  If true, skip this cluster during search if it is disconnected. Default: false

Responses

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)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Values are deployments.deployment_not_found or deployments.deployment_resource_not_found.
Hide response attribute Show response attribute object
- errors array[object] Required
  
  A list of errors that occurred in the failing request
  
  Hide errors attributes Show errors attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string Required
  
  A human readable message describing the error that occurred
  
  fields array[string]
  
  If the error can be tied to a specific field or fields in the user request, this lists those fields

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

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

Request examples

{
  "resources": [
    {
      "deployment_id": "string",
      "elasticsearch_ref_id": "string",
      "alias": "string",
      "skip_unavailable": true
    }
  ]
}

Response examples (202)

{}

Response examples (404)

# Headers
x-cloud-error-codes: deployments.deployment_not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}