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.

« Clusters - Elasticsearch - Support Generate logs »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.12] ›RESTful API ›API reference ›Clusters - Elasticsearch - Support

Generate diagnostics

edit

Generate diagnostics

edit

DEPRECATED (Scheduled to be removed in the next major version): Retrieves a support diagnostic bundle from an active Elasticsearch cluster. To successfully retrieve a support diagnostic bundle, the cluster must be responsive.

Request

edit

GET /api/v1/clusters/elasticsearch/{cluster_id}/support/_generate-diagnostics

Path parameters

edit
Name Type Required Description

cluster_id

string

Y

The Elasticsearch cluster identifier.

Responses

edit
200

(string as byte) The support diagnostic bundle was successfully generated

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

Request example

edit
curl -XGET https://{{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/support/_generate-diagnostics \
-H "Authorization: ApiKey $ECE_API_KEY"
« Clusters - Elasticsearch - Support Generate logs »