Set certificate based remote clusters

PUT /deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters
Basic auth Api key

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).

application/json

Body Required

List of certificate based remote clusters for the resource

  • 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

    • info object

      Information about a Remote Cluster.

      Hide info attributes Show info attributes object
      • healthy boolean Required

        Whether or not the remote cluster is healthy

      • connected boolean Required

        Whether or not there is at least one connection to the remote cluster.

      • compatible boolean Required

        Whether or not the remote cluster version is compatible with this cluster version.

      • trusted boolean Required

        Whether or not the remote cluster is trusted by this cluster.

      • trusted_back boolean Required

        Whether or not the remote cluster trusts this cluster back.

Responses

  • 202 application/json

    The Remote Clusters were updated
  • 404 application/json
    • 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 \
 --request PUT 'https://{{hostname}}/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters' \
 --user "username:password" \
 --header "Content-Type: application/json" \
 --data '{
  "resources": [
    {
      "deployment_id": "string",
      "elasticsearch_ref_id": "string",
      "alias": "string",
      "skip_unavailable": true,
      "info": {
        "healthy": true,
        "connected": true,
        "compatible": true,
        "trusted": true,
        "trusted_back": true
      }
    }
  ]
}'