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.
q
(string) An optional query to filter Kibana clusters by. Maps to an Elasticsearch query_string query.
show_hidden
(boolean; default: false) Includes the hidden clusters in the response.
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_plans
(boolean) Includes the active and pending plan information in the response. NOTE: This option can result in large responses.
size
(integer; default: 100) The maximum number of clusters to include in the response. For all clusters, use -1. NOTE: This option can result in large responses.

Responses

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