Get remote cluster information

GET /_remote/info

Auth

Get information about configured remote clusters. The API returns connection and endpoint information keyed by the configured remote cluster alias.

Note

This API returns information that reflects current state on the local cluster. The connected field does not necessarily reflect whether a remote cluster is down or unavailable, only whether there is currently an open connection to it. Elasticsearch does not spontaneously try to reconnect to a disconnected remote cluster. To trigger a reconnection, attempt a cross-cluster search, ES|QL cross-cluster search, or try the resolve cluster endpoint.

More about cross-cluster search

Required privileges

Cluster privileges monitor

Response

application/json

Response Type: map string to oneOf

View as Markdown

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_remote/info

JavaScript Elasticsearch JavaScript Client

const response = await client.cluster.remoteInfo();

Python Elasticsearch Python Client

resp = client.cluster.remote_info()

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_remote/info" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.cluster().remoteInfo();

C# Elasticsearch .NET Client

var response = await client.Cluster.RemoteInfoAsync();

PHP Elasticsearch PHP Client

$resp = $client->cluster()->remoteInfo();

Ruby Elasticsearch Ruby Client

response = client.cluster.remote_info

Response

{
  "key": {
    "mode": "sniff",
    "connected": false,
    "max_connections_per_cluster": 0,
    "num_nodes_connected": 0,
    "initial_connect_timeout": "string",
    "skip_unavailable": false,
    "seeds": [
      "string"
    ]
  }
}

Generated from the API spec