Skip to main content
GET
/
deployments
/
{deployment_id}
/
elasticsearch
/
{ref_id}
/
remote-clusters
Get certificate based remote clusters
curl --request GET \
  --url https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters \
  --header 'Authorization: <api-key>'
{
  "resources": [
    {
      "alias": "<string>",
      "deployment_id": "<string>",
      "elasticsearch_ref_id": "<string>",
      "info": {
        "compatible": "<boolean>",
        "connected": "<boolean>",
        "healthy": "<boolean>",
        "trusted": "<boolean>",
        "trusted_back": "<boolean>"
      },
      "skip_unavailable": "<boolean>"
    },
    {
      "alias": "<string>",
      "deployment_id": "<string>",
      "elasticsearch_ref_id": "<string>",
      "info": {
        "compatible": "<boolean>",
        "connected": "<boolean>",
        "healthy": "<boolean>",
        "trusted": "<boolean>",
        "trusted_back": "<boolean>"
      },
      "skip_unavailable": "<boolean>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
deployment_id
string
required

(Required) Identifier for the Deployment.

Example:

"<string>"

​
ref_id
string
required

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

Example:

"<string>"

Response

List of certificate based remote clusters for the resource

​
resources
object[]
Example:
[
  {
    "alias": "<string>",
    "deployment_id": "<string>",
    "elasticsearch_ref_id": "<string>",
    "info": {
      "compatible": "<boolean>",
      "connected": "<boolean>",
      "healthy": "<boolean>",
      "trusted": "<boolean>",
      "trusted_back": "<boolean>"
    },
    "skip_unavailable": "<boolean>"
  },
  {
    "alias": "<string>",
    "deployment_id": "<string>",
    "elasticsearch_ref_id": "<string>",
    "info": {
      "compatible": "<boolean>",
      "connected": "<boolean>",
      "healthy": "<boolean>",
      "trusted": "<boolean>",
      "trusted_back": "<boolean>"
    },
    "skip_unavailable": "<boolean>"
  }
]
⌘I