Get clusters

convert_legacy_plans

boolean; default: false

N

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: false

N

When plans are shown, includes the missing elements from the applicable deployment template.

from

integer; default: 0

N

The number of clusters to skip.

q

string

N

An optional query to filter Elasticsearch clusters by. Maps to an Elasticsearch query_string query.

show_hidden

boolean

N

Includes the hidden clusters in the response.

show_metadata

boolean; default: false

N

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

N

When plans are shown, includes the default values in the response. NOTE: This option results in large responses.

show_plans

boolean; default: false

N

Includes the active and pending plan information in the response. NOTE: This option can result in large responses.

show_security

boolean; default: false

N

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

N

Includes the cluster settings in the response.

show_system_alerts

integer; default: 0

N

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.

size

integer; default: 100

N

Maximum number of clusters to include in the response. For all clusters, use -1. NOTE: This option can result in large responses and is not supported if a query is also specified.