IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Shutdown Deployment Elasticsearch Resource Start all instances »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.13] ›RESTful API ›API reference ›Deployment - Commands

Get details about heap dumps for a Deployment

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Get details about heap dumps for a Deployment

edit

Gets details about existing heap dumps and in progress heap dump captures across all instances belonging to the deployment.

Request

edit

GET /api/v1/deployments/{deployment_id}/heap_dumps

Path parameters

edit
Name Type Required Description

deployment_id

string

Y

Identifier for the Deployment.

Responses

edit
200

(DeploymentHeapDumps)

The heap dump details for all instances belonging to the deployment

404

(BasicFailedReply)

The deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_not_found])
The error codes associated with the response

Request example

edit
curl -XGET https://{{hostname}}/api/v1/deployments/{deployment_id}/heap_dumps \
-H "Authorization: ApiKey $ECE_API_KEY"
« Shutdown Deployment Elasticsearch Resource Start all instances »