Get clusters

Retrieves cluster information for all Kibana clusters.

Request

GET /api/v1/clusters/kibana

Query parameters

from
(integer; default: 0) The number of clusters to skip over
q
(string) An optional query to filter Kibana clusters by. Maps to an Elasticsearch query_string query.
show_hidden
(boolean; default: false) 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) Whether to include the full current and pending plan information in the response - can be large per cluster
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
(KibanaClustersInfo) Returning the specified set of clusters from the platform