Request agent diagnostics

Server: 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] Route required privileges: fleet-agents-read.

Path Parameters

agentId string required: The agent ID

Request

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

Responses

Successful response

application/json

Bad Request

application/json

Examples

Request a diagnostics bundle from an agent

Request Console 1 / 2 languages

Console Kibana Dev Tools

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

curl Shell

curl -X POST "https://{kibana_url}/api/fleet/agents/{agentId}/request_diagnostics" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
  "additional_metrics": [
    "CPU"
  ]
}'

Response

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

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