Get clusters | Elastic Cloud Enterprise Reference [2.4]

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

› › › ›

Retrieves cluster information for all APM clusters.

GET /api/v1/clusters/apm

Name	Type	Required	Description
`from`	`integer`; default: `0`	N	The number of clusters to skip.
`q`	`string`	N	An optional query to filter APM 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.

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

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