Get certificate based remote clusters

Base URL: https://api.elastic-cloud.com/api/v1

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

No auth

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

Responses

List of certificate based remote clusters for the resource

application/json

resources object[] required: The remote resources

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)

application/json

Base URL: https://api.elastic-cloud.com/api/v1

Examples

Request curl 1 / 1 language

curl Shell

curl -X GET "https://api.elastic-cloud.com/api/v1/deployments/${DEPLOYMENT_ID}/elasticsearch/${REF_ID}/remote-clusters"

Generated from the API spec

Response

{
  "resources": [
    {
      "deployment_id": "string",
      "elasticsearch_ref_id": "string",
      "alias": "string",
      "skip_unavailable": false,
      "info": {
        "healthy": false,
        "connected": false,
        "compatible": false,
        "trusted": false,
        "trusted_back": false
      }
    }
  ]
}

Generated from the API spec

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

Generated from the API spec