Get cluster

Retrieves cluster information for a Kibana cluster.

Request

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

Path parameters

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

Query parameters

convert_legacy_plans
(boolean; default: false) 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')
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

Responses

200
(KibanaClusterInfo) Returning the information for the specified Kibana cluster
404
(BasicFailedReply) The cluster specified by {cluster_id} cannot be found (code: 'clusters.cluster_not_found')