Cluster
The cluster APIs enable you to retrieve information about your infrastructure on cluster, node, or shard level. You can manage cluster settings and voting configuration exceptions, collect node statistics and retrieve node information.
-
Ping the cluster
- HEAD
-
Explain the shard allocations
Stack
5.0+
- POST also GET /_cluster/allocation/explain
-
Get the cluster health status
Stack
1.3+
- GET /_cluster/health/{index}
-
Get the pending cluster tasks
- GET /_cluster/pending_tasks
-
Reroute the cluster
Stack
5.0+
- POST /_cluster/reroute
-
Get cluster-wide settings
- GET /_cluster/settings
-
Update the cluster settings
- PUT /_cluster/settings
-
Get the cluster state
Stack
1.3+
- GET /_cluster/state/{metric}/{index}
-
Get cluster statistics
Stack
1.3+
- GET /_cluster/stats/nodes/{node_id}
-
Update voting configuration exclusions
Stack
7.0+
- POST /_cluster/voting_config_exclusions
-
Clear cluster voting config exclusions
Stack
7.0+
- DELETE /_cluster/voting_config_exclusions
-
Get cluster subsystem info
Stack
8.9+
- GET /_info/{target}
-
Get cluster repositories metering
Stack
Experimental
7.16+
- GET /_nodes/{node_id}/_repositories_metering
-
Clear the archived repositories metering
Stack
Experimental
7.16+
- DELETE /_nodes/{node_id}/_repositories_metering/{max_archive_version}
-
Get the hot threads for nodes
- GET /_nodes/{node_id}/hot_threads
-
Reload the keystore on nodes in the cluster
Stack
6.5+
- POST /_nodes/{node_id}/reload_secure_settings
-
Get node statistics
- GET /_nodes/{node_id}/stats/{metric}/{index_metric}
-
Get feature usage information
Stack
6.0+
- GET /_nodes/{node_id}/usage/{metric}
-
Get node information
Stack
1.3+
- GET /_nodes/{node_id}/{metric}
-
Get remote cluster information
Stack
6.1+
- GET /_remote/info