Get clustersedit
Retrieves the information for all Kibana instances.
Requestedit
GET /api/v1/clusters/kibana
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
The number of clusters to skip. |
|
|
N |
An optional query to filter Kibana clusters by. Maps to an Elasticsearch query_string query. |
|
|
N |
Includes the hidden clusters in the response. |
|
|
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 and pending plan information in the response. NOTE: This option can result in large responses. |
|
|
N |
Includes the cluster settings in the response. |
|
|
N |
The maximum number of clusters to include in the response. For all clusters, use -1. NOTE: This option can result in large responses. |
Responsesedit
-
200
-
(
KibanaClustersInfo
) Returning the specified set of clusters from the platform
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
curl -XGET {{hostname}}/api/v1/clusters/kibana \ -H "Authorization: ApiKey $ECE_API_KEY"