Get cluster | Elastic Cloud Enterprise Reference [2.3]

A newer version is available. For the latest information, see the current release documentation.

› › › ›

Retrieves the Kibana instance information.

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

Name	Type	Required	Description
`cluster_id`	`string`	Y	The Kibana deployment identifier.

Name	Type	Required	Description
`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`.
`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_plan_logs`	`boolean`; default: `false`	N	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`	N	Includes the active and pending plan information in the response. NOTE: This option can result in large responses.
`show_settings`	`boolean`; default: `false`	N	Includes the cluster settings in the response.

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)

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

curl -XGET {{hostname}}/api/v1/clusters/kibana/{cluster_id} \
-u $CLOUD_USER:$CLOUD_KEY