Clusters - Elasticsearch - Support

Generate diagnostics

Retrieves a support diagnostic bundle from an active Elasticsearch cluster. To successfully retrieve a support diagnostic bundle, the cluster must be responsive.

Request

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

Path parameters

NameTypeRequiredDescription

cluster_id

string

Y

The Elasticsearch cluster identifier.

Responses

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')

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

Request example

curl -XGET {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/support/_generate-diagnostics \
-H "Authorization: ApiKey $CLOUD_API_KEY"

Generate logs

Retrieves the log file for the Elasticsearch cluster.

Request

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

Path parameters

NameTypeRequiredDescription

cluster_id

string

Y

The Elasticsearch cluster identifier.

Query parameters

NameTypeRequiredDescription

date

string

Y

The log retrieval start date in standard format. For example, YYYY-MM-DD [THH [:mm] ].

Responses

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')

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

Request example

curl -XGET {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/support/_generate-logs \
-H "Authorization: ApiKey $CLOUD_API_KEY"