Get clusters

Retrieves cluster information for all Elasticsearch clusters.

Request

GET /api/v1/clusters/elasticsearch

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: false) If showing plans, whether to enrich the plan by including the missing elements from the deployment template it is based on
from
(integer; default: 0) The number of clusters to skip over
q
(string) An optional query to filter Elasticsearch clusters by. Maps to an Elasticsearch query_string query.
show_hidden
(boolean) Whether to include hidden clusters in the response or not
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_plans
(boolean; default: false) 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.
size
(integer; default: 100) The maximum number of clusters to return (set to -1 for all clusters - use with care, can result in large responses)

Responses

200
(ElasticsearchClustersInfo) Returning the specified set of clusters from the platform