Request agent diagnostics

Base URL: https://{kibana_url}

POST /api/fleet/agents/{agentId}/request_diagnostics
POST /s/{space_id}/api/fleet/agents/{agentId}/request_diagnostics

Refer to Spaces for more information.

Request a diagnostics bundle from a specific agent.

Required authorization

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Header parameters

Request body

Responses

Successful response

application/json

Bad Request

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Request a diagnostics bundle from an agent

Console Kibana Dev Tools

POST kbn:/api/fleet/agents/AGENT_ID/request_diagnostics
{
  "additional_metrics": [
    "CPU"
  ]
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/agents/${AGENT_ID}/request_diagnostics" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "additional_metrics": [
      "CPU"
    ]
  }'