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.
Generate diagnostics
editGenerate diagnostics
editDEPRECATED (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
editGET /api/v1/clusters/elasticsearch/{cluster_id}/support/_generate-diagnostics
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
The Elasticsearch cluster identifier. |
Responses
edit-
200
-
(
string
asbyte
) 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
-
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request example
editcurl -XGET https://{{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/support/_generate-diagnostics \ -H "Authorization: ApiKey $ECE_API_KEY"