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

Auth

Request a diagnostics bundle from a specific agent.

Required privileges

Privileges fleet-agents-read

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.
agentId string required: The agent ID

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

additional_metrics enum[] · max items: 1: Values: CPU

Responses

Successful response

application/json

Any of:

actionId string required

Bad Request

application/json

View as Markdown

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"
    ]
  }'

Generated from the API spec

Response

Diagnostics action result

{
  "actionId": "action-id-1"
}

{
  "error": "Bad Request",
  "message": "Agent agent-id-1 does not support request diagnostics action.",
  "statusCode": 400
}