Capture diagnostics for an Elasticsearch or Kibana resource

POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/diagnostics/_capture

Auth

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

Path parameters

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

Query parameters

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

Responses

The diagnostic bundle as a zip file

application/json

Response Type: string · format: byte

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

The diagnostics cannot be generated because the cluster is either stopped or initializing. (code: clusters.cluster_plan_state_error)

application/json

Examples

Request curl 1 / 1 language

curl Shell

curl -X POST "${API_URL}/deployments/${DEPLOYMENT_ID}/${RESOURCE_KIND}/${REF_ID}/diagnostics/_capture" \
  -u "${USERNAME}:${PASSWORD}"

Generated from the API spec

Response

"string"

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec