It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Get cluster
editGet cluster
editRetrieves the Kibana instance information.
Request
editGET /api/v1/clusters/kibana/{cluster_id}
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
The Kibana deployment identifier. |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
When |
|
|
N |
Includes all of the cluster metadata in the response. NOTE: Responses can include a large amount of metadata, as well as credentials. |
|
|
N |
When plans are shown, includes the default values in the response. NOTE: This option results in large responses. |
|
|
N |
Includes the active, pending, and historical plan information in the attempt log. NOTE: This option can result in large responses. |
|
|
N |
Includes the active and pending plan information in the response. NOTE: This option can result in large responses. |
|
|
N |
Includes the cluster settings in the response. |
Responses
edit-
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
)Headers
-
x-cloud-error-codes
(string
; allowed values: [clusters.cluster_not_found
]) - The error codes associated with the response
-
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request example
editcurl -XGET {{hostname}}/api/v1/clusters/kibana/{cluster_id} \ -H "Authorization: ApiKey $ECE_API_KEY"