Get cluster

Retrieves cluster information for a Kibana cluster.

Request

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

Path parameters

cluster_id (required)
(string) The Kibana deployment identifier.

Query parameters

convert_legacy_plans
(boolean; default: false) When true, converts the plans to the 2.0.x format. When false, uses the 1.x format. The default is false.
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_plan_logs
(boolean; default: false) Includes the active, pending, and historical plan information in the attempt log. NOTE: This option can result in large responses.
show_plans
(boolean; default: true) Includes the active and pending plan information in the response. NOTE: This option can result in large responses.

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')