Capture diagnostics for an Elasticsearch or Kibana resource
Auth
Retrieves a diagnostic bundle from an active cluster. To successfully retrieve a diagnostic bundle, the cluster must be responsive.
Expand all
deployment_id
string required
Identifier for the Deployment
resource_kind
string required
The kind of resource (one of elasticsearch or kibana).
ref_id
string required
User-specified RefId for the Resource (or '_main' if there is only one).
mode
enum · default: full
Capture mode - whether to obtain all the diagnostics data or the lightweight, essential-only subset of it. Applicable only to Elasticsearch, ignored for any other components which have just one capture mode implemented.
Values:
full
light
200
The diagnostic bundle as a zip file
application/json
Response Type: string · format: byte
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)
application/json
errors
object [] required
A list of errors that occurred in the failing request
−
Hide 3 properties
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
string []
If the error can be tied to a specific field or fields in the user request, this lists those fields
412
The diagnostics cannot be generated because the cluster is either stopped or initializing. (code: clusters.cluster_plan_state_error)
application/json
errors
object [] required
A list of errors that occurred in the failing request
−
Hide 3 properties
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
string []
If the error can be tied to a specific field or fields in the user request, this lists those fields