Get cluster

Retrieves cluster information for an Elasticsearch cluster.

Request

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

Path parameters

cluster_id (required)
(string) Identifier for the Elasticsearch cluster

Query parameters

convert_legacy_plans
(boolean; default: false) If showing plans, whether to leave pre-2.0.0 plans in their legacy format (the default), or whether to update them to 2.0.x+ format (if 'true')
enrich_with_template
(boolean; default: true) If showing plans, whether to enrich the plan by including the missing elements from the deployment template it is based on
show_metadata
(boolean; default: false) Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials
show_plan_defaults
(boolean; default: false) If showing plans, whether to show values that are left at their default value (less readable but more informative)
show_plan_logs
(boolean; default: false) Whether to include with the current and pending plan information the attempt log - can be very large per cluster
show_plans
(boolean; default: true) Whether to include the full current and pending plan information in the response - can be large per cluster
show_security
(boolean; default: false) Whether to include the Elasticsearch 2.x security information in the response - can be large per cluster and also include credentials
show_settings
(boolean; default: false) Whether to show cluster settings in the response.
show_system_alerts
(integer; default: 0) Number of system alerts (such as forced restarts due to memory limits) to be included in the response - can be large per cluster. Negative numbers or 0 will not return field.

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')