Get cluster

Retrieves cluster information for an Elasticsearch cluster.

Request

GET /api/v1/clusters/elasticsearch/{cluster_id}

Path parameters

cluster_id (required)
(string) The Elasticsearch cluster identifier.

Query parameters

convert_legacy_plans
(boolean; default: false) When true, converts the plans to the 2.0.x format. When false, uses the 1.x format. The default is false.
enrich_with_template
(boolean; default: true) When plans are shown, includes the missing elements from the applicable deployment template.
show_metadata
(boolean; default: false) Includes all of the cluster metadata in the response. NOTE: Responses can include a large amount of metadata, as well as credentials.
show_plan_defaults
(boolean; default: false) When plans are shown, includes the default values in the response. NOTE: This option results in large responses.
show_plan_logs
(boolean; default: false) Includes the active, pending, and historical plan information in the attempt log. NOTE: This option can result in large responses.
show_plans
(boolean; default: true) Includes the active and pending plan information in the response. NOTE: This option can result in large responses.
show_security
(boolean; default: false) Includes the Elasticsearch 2.x security information in the response. NOTE: Responses can include a large amount of metadata, as well as credentials.
show_settings
(boolean; default: false) Includes the cluster settings in the response.
show_system_alerts
(integer; default: 0) The number of system alerts to include in the response. For example, the number of forced restarts caused from a limited amount of memory. Only numbers greater than zero return a field. NOTE: Responses can include a large number of system alerts.

Responses

200
(ElasticsearchClusterInfo) Returning the information for the specified Elasticsearch cluster
404
(BasicFailedReply) The cluster specified by {cluster_id} cannot be found (code: 'clusters.cluster_not_found')