Get auto upgrade agent status

Base URL: https://{kibana_url}

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

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

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

Responses

Successful response

application/json

Bad Request

application/json

Base URL: https://{kibana_url}

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
}