Request agent diagnostics | Kibana Serverless API

Request agent diagnostics Beta

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

Headers

elastic-api-version string

The version of the API to use

Value is 2023-10-31. Default value is 2023-10-31.
kbn-xsrf string Required

A required header to protect against CSRF attacks

Path parameters

agentId string Required

application/json; Elastic-Api-Version=2023-10-31

Body

additional_metrics array[string]

Value is CPU.

Responses

200 application/json; Elastic-Api-Version=2023-10-31
Hide response attribute Show response attribute object
- actionId string Required
400 application/json; Elastic-Api-Version=2023-10-31
Hide response attributes Show response attributes object
- error string
- message string Required
- statusCode number

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

curl \
 -X POST https://localhost:5601/api/fleet/agents/{agentId}/request_diagnostics \
 -H "Content-Type: application/json; Elastic-Api-Version=2023-10-31" \
 -H "elastic-api-version: 2023-10-31" \
 -H "kbn-xsrf: true"

Request examples

# Headers
elastic-api-version: 2023-10-31
kbn-xsrf: true

# Payload
{
  "additional_metrics": [
    "CPU"
  ]
}

Response examples (200)

{
  "actionId": "string"
}

Response examples (400)

{
  "error": "string",
  "message": "string",
  "statusCode": 42.0
}