Path parameters

• deployment_id string Required

  Identifier for the Deployment.

• resource_kind string Required

  The kind of resource (one of elasticsearch, kibana or apm).

• ref_id string Required

  User-specified RefId for the Resource (or '_main' if there is only one).

• instance_id string Required

  The instance identifier

Responses

• 200

  The given instance's heap dump
• 404
  • The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)
  • The Resource specified by {ref_id} cannot be found. (code: deployments.deployment_resource_not_found)
  • The specified instance cannot be found. (code: deployments.instance_not_found_error)
  • The specified instance does not have a heap dump available to download. (code: heap_dumps.heap_dump_not_found)
  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Values are deployments.deployment_not_found, deployments.deployment_resource_not_found, deployments.instance_not_found_error, or heap_dumps.heap_dump_not_found.

  Hide response attribute Show response attribute object

  • errors array[object] Required

    A list of errors that occurred in the failing request

    Hide errors attributes Show errors attributes object

    • code string Required

      A structured code representing the error type that occurred

    • message string Required

      A human readable message describing the error that occurred

    • fields array[string]

      If the error can be tied to a specific field or fields in the user request, this lists those fields