Get clusters

DEPRECATED (Scheduled to be removed in the next major version): Retrieves the information for all Kibana instances.

Request

GET /api/v1/clusters/kibana

Query parameters

Name Type Required Description

from

integer; default: 0

N

The number of clusters to skip.

q

string

N

An optional query to filter Kibana clusters by. Maps to an Elasticsearch query_string query.

show_hidden

boolean; default: false

N

Includes the hidden clusters in the response.

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_plans

boolean

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.

size

integer; default: 100

N

The maximum number of clusters to include in the response. For all clusters, use -1. NOTE: This option can result in large responses.

Responses

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 example

curl -XGET https://{{hostname}}/api/v1/clusters/kibana \
-H "Authorization: ApiKey $ECE_API_KEY"