This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« Pending cluster tasks API Task management API »

› › ›

Remote cluster info API

edit

Remote cluster info API

edit

Returns configured remote cluster information.

Request

edit

GET /_remote/info

Prerequisites

edit

If the Elasticsearch security features are enabled, you must have the monitor or manage cluster privilege to use this API.

Description

edit

The cluster remote info API allows you to retrieve all of the configured remote cluster information. It returns connection and endpoint information keyed by the configured remote cluster alias.

Response body

edit

mode: Connection mode for the remote cluster. Returned values are sniff and proxy.
connected: True if there is at least one connection to the remote cluster.
initial_connect_timeout: The initial connect timeout for remote cluster connections.

skip_unavailable: Whether a cross-cluster search skips the remote cluster if its nodes are unavailable during the search. If true, a cross-cluster search also ignores errors returned by the remote cluster. Refer to Optional remote clusters.
seeds: Initial seed transport addresses of the remote cluster when sniff mode is configured.
num_nodes_connected: Number of connected nodes in the remote cluster when sniff mode is configured.
max_connections_per_cluster: Maximum number of connections maintained for the remote cluster when sniff mode is configured.
proxy_address: Address for remote connections when proxy mode is configured.
num_proxy_sockets_connected: Number of open socket connections to the remote cluster when proxy mode is configured.
max_proxy_socket_connections: The maximum number of socket connections to the remote cluster when proxy mode is configured.
cluster_credentials: This field presents and has value of ::es_redacted:: only when the remote cluster is configured with the API key based model. Otherwise, the field is not present.

« Pending cluster tasks API Task management API »