Get auto upgrade agent status

GET /api/fleet/agent_policies/{agentPolicyId}/auto_upgrade_agents_status
GET /s/{space_id}/api/fleet/agent_policies/{agentPolicyId}/auto_upgrade_agents_status

Auth

Get the auto-upgrade status for agents assigned to an agent policy.

Required authorization

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.
agentPolicyId string required: The ID of the agent policy

Successful response

application/json

Bad Request

application/json

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/fleet/agent_policies/AGENT_POLICY_ID/auto_upgrade_agents_status

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/fleet/agent_policies/${AGENT_POLICY_ID}/auto_upgrade_agents_status" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

Auto-upgrade status for agents in the policy

{
  "agentsCount": 5,
  "currentVersion": "8.16.0",
  "failedAgentsCount": 0,
  "upgradedAgentsCount": 3,
  "upgradingAgentsCount": 1
}

{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}